unitizer (version 1.4.6)

desc: One Line Description of Object

Description

Objects are described by class, and dimensions. Dimensions is always denoted in square brackets. For example, “int[10]” means an integer of length ten. Typically an object will be identified by head(class(obj), 1L) along with its dimensions. Recursive objects will have the first level shown provided that doing so fits within limit.

Usage

desc(val, limit = getOption("width"))

Arguments

val

object to describe

limit

max characters to display

Value

character(1L) describing object

Details

Eventually this will be migrated to an S3 generic to allow recursive dispatch on object type.

Examples

# NOT RUN {
desc(list(a=iris, b=lm(dist ~ speed, cars), 1:10, matrix(letters, 2)))
# }