summary.data.list: Information about data list objects

In stevencarlislewalker/multitable: Simultaneous Manipulation of Multiple Arrays of Data

Description

Summarize and compactly display the structure of a data list object.

Usage

## S3 method for class 'data.list'
summary(object, ...)

## S3 method for class 'data.list'
str(object, give.attr = FALSE, hide.internals = TRUE, ...)

Arguments

object	A data list object
give.attr	See documentation for str. Ignored if hide.internals is FALSE.
hide.internals	If FALSE, object is unclassed first to reveal further internal details.
...	Potential further arguments (see str)

Details

The summary.data.list function returns a logical matrix indicating which dimensions (rows) are associated with which variables (columns) of the data list object.

Currently str.data.list is identical to str except that give.attr defaults to FALSE, because data lists are 'cluttered' with attributes that should not be part of the str summary. Also, setting the hide.internals argument to FALSE reveals more information. Perhaps in the future, a special str method will be written for data lists.

Note

The hide.internals argument was suggested by a reviewer of a JSS manuscript.

See Also

summary, str

Examples

data(fake.community)
summary(fake.community)
str(fake.community)

stevencarlislewalker/multitable documentation built on May 30, 2019, 4:44 p.m.