List Objects

Description

ls andobjects return a vector of character stringsgiving the names of the objects in the specified environment. Wheninvoked with no argument at the top level prompt,ls shows whatdata sets and functions a user has defined. When invoked with noargument inside a function,ls returns the names of thefunction's local variables: this is useful in conjunction withbrowser.

Usage

ls(name, pos = -1L, envir = as.environment(pos),   all.names = FALSE, pattern, sorted = TRUE)objects(name, pos= -1L, envir = as.environment(pos),        all.names = FALSE, pattern, sorted = TRUE)

Arguments

Details

Thename argument can specify the environment from whichobject names are taken in one of several forms:as an integer (the position in thesearch list); asthe character string name of an element in the search list; or as anexplicitenvironment (including usingsys.frame to access the currently active function calls).By default, the environment of the call tols orobjectsis used. Thepos andenvir arguments are an alternativeway to specify an environment, but are primarily there for backcompatibility.

Note that theorder of strings forsorted = TRUE islocale dependent, seeSys.getlocale. Ifsorted = FALSE the order is arbitrary, depending if the environment ishashed, the order of insertion of objects, ....

References

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988)The New S Language.Wadsworth & Brooks/Cole.

See Also

glob2rx for converting wildcard patterns to regularexpressions.

ls.str for a long listing based onstr.apropos (orfind)for finding objects in the whole search path;grep for more details on ‘regular expressions’;class,methods, etc., forobject-oriented programming.

Examples

.Ob <- 1ls(pattern = "O")ls(pattern= "O", all.names = TRUE)    # also shows ".[foo]"# shows an empty list because inside myfunc no variables are definedmyfunc <- function() {ls()}myfunc()# define a local variable inside myfuncmyfunc <- function() {y <- 1; ls()}myfunc()                # shows "y"