dims {FLCore}R Documentation

Provide information onn the dimensions and range of an object

Description

A descriptive list of the dimensions and dimension names, as well as ranges along different dimensions for different FLCore objects. Information is taken from range as well as directly from the objects at call time.

Usage

dims(obj, ...)

Arguments

obj Any object.
... Any extra arguments available for some classes.

Details

Return object is a list ~~ If necessary, more details than the description above ~~

Value

Return object is a nmed list containing a number of slots, depending on the object class. For example, for FLQuant-class, dims returns:

quant Length of the first (quant) dimension. The name of this slot reflects the quant name.
min Starting value of the quant dimension, if numeric.
max Final value of the quant dimension, if numeric.
year Length of the year dimension.
minyear First year.
maxyear Last year.
unit Number of units.
season Number of seasons.
area Number of areas.

Author(s)

FLR Team

See Also

dim, dimnames

Examples

        dims(FLQuant(rnorm(10), dim=c(2,5,1,1,1), quant='age'))

[Package FLCore version 1.3-3 Index]