distillery (version 1.2-1)

distill: Distill An Object

Description

Distill a complex object to something easier to manage, like a numeric vector.

Usage

distill(x, ...)
# S3 method for list
distill(x, ...)
# S3 method for matrix
distill(x, ...)
# S3 method for data.frame
distill(x, ...)

Arguments

x

A list, vector, matrix or data frame, or other object that has a distill method, e.g., fevd objects.

…

Not used.

Value

numeric vector, possibly named.

Details

Perhaps a fine line exists between functions such as c, print, str, summary, etc. The idea behind the distill method is to have a function that “distills” out the most pertinent information from a more complex object. For example, when fitting a model to a number of spatial locations, it can be useful to pull out only certain information into a vector for ease of analysis. With many models, it might not be feasible to store (or analyze) large complicated data objects. In such a case, it may be useful to keep only a vector with the most pertinent information (e.g., parameter estimates, their standard errors, the likelihood value, AIC, BIC, etc.). For example, this is used within extRemes >= 2.0 on the “fevd” class objects with the aim at fitting models to numerous locations within an apply call so that something easily handled is returned, but with enough information as to be useful.

The data frame and matrix methods attempt to name each component of the vector. The list method simply does c(unlist(x)).

See Also

c, unlist, print, summary, str, args

Examples

# NOT RUN {
x <- cbind(1:3, 4:6, 7:9)
distill(x)

x <- data.frame(x=1:3, y=4:6, z=7:9)
distill(x)
# }