R: List Objects and their Structure

ls.str {utils}

R Documentation

List Objects and their Structure

Description

ls.str and lsf.str are “variations” of ls applying str() to each matched name, see section ‘Value’.

Usage

 ls.str(pos = 1, pattern, ...,  envir = as.environment(pos), mode = "any")
lsf.str(pos = 1, ..., envir = as.environment(pos))
## S3 method for class 'ls_str'
print(x, max.level = 1, give.attr = FALSE, ...)

Arguments

pos

integer indicating search path position.

pattern

a regular expression passed to ls. Only names matching pattern are considered.

max.level

maximal level of nesting which is applied for displaying nested structures, e.g., a list containing sub lists. Default 0: Display all nesting levels.

give.attr

logical; if TRUE (default), show attributes as sub structures.

envir

environment to use, see ls.

mode

character specifying the mode of objects to consider. Passed to exists and get.

x

an object of class "ls_str".

...

further arguments to pass. and lsf.str passes them to ls.str which passes them on to ls. The (non-exported) print method print.ls_str passes them to str.

Value

ls.str and lsf.str return an object of class "ls_str", basically the character vector of matching names (functions only for lsf.str), similarly to ls, with a print() method that calls str() on each object.

Author(s)

Martin Maechler

Examples

lsf.str()#- how do the functions look like which I am using?
ls.str(mode = "list") #- what are the structured objects I have defined?

print(ls.str(), max.level = 1)# don't show details

## which base functions have "file" in their name ?
lsf.str(pos = length(search()), pattern = "file")

[Package utils version 2.0.0 ]