Learn R Programming

R.oo (version 1.26.0)

ll: Generates a list of informative properties of all members of an environment

Description

Generates a list of informative properties of all members of an environment.

Usage

# S3 method for default
ll(pattern=".*", ..., private=FALSE, properties=getOption("R.oo::ll/properties",
  c("data.class", "dimension", "objectSize")), sortBy=NULL, decreasing=FALSE,
  envir=parent.frame())

Value

Returns a data.frame containing information about all the members.

Arguments

pattern

Regular expression pattern specifying which members to return. If ".*", all names are matched.

...

A named vector of format functionName=value, where functionName() will be called on each member found. If the result matches the value, the member is returned, otherwise not.

private

If TRUE, also private members, i.e. members with a name starting with a . (period), will be listed, otherwise not.

properties

Names of properties to be returned. There must exist a function with the same name, because it will be called. This way one can extract any type of property by defining new methods.

sortBy

Name or index of column (property) to be sorted by. If NULL, the objects are listed in the order they are found.

decreasing

A logical indicating whether the sorting should be done in increasing or decreasing order.

envir

An environment, a search path index or a name of a package to be scanned.

Default properties returned

It is possible to set the default value of argument properties by setting option "R.oo::ll/properties", e.g. options("R.oo::ll/properties"=c("data.class", "dimension")). If this option is not set when the package is loaded, it is set to c("data.class", "dimension", "objectSize").

Author

Henrik Bengtsson

See Also

ls.str and ll.Object().