summarytools (version 0.9.2)

what.is: Obtain Extended Properties of Objects

Description

Combination of most common “macro-level” functions that describe an object.

Usage

what.is(x, show.all = FALSE, ignore.size.warn = FALSE)

Arguments

x

Any object.

show.all

Logical. When TRUE, all logical results from the “is.” identifier functions will be displayed, with a warning message when the result applies only to the first element in the structure. FALSE by default.

ignore.size.warn

Set to TRUE to force execution of the function for large (> 20 K-bytes) objects. Defaults to FALSE.

Value

A list with following elements:

properties

A data frame with the class(es), type, mode and storage mode of the object as well as the dim, length and object.size.

attributes.lengths

A named character vector giving all attributes (c.f. “names”, “row.names”, “class”, “dim”, and so forth) along with their length.

extensive.is

A character vector of all the identifier functions. (starting with “is.”) that yield TRUE when used with x as argument.

function.type

When x is a function, results of ftype are added.

Details

An alternative to calling in turn class, typeof, dim, and so on. A call to this function will readily give all this information at once.

See Also

class, typeof, mode, storage.mode, dim, length, is.object, otype, object.size, ftype

Examples

# NOT RUN {
what.is(1)
what.is(NaN)
what.is(iris3)
what.is(print)
what.is(what.is)

# }