units {FLCore}R Documentation

Extract and modify the units slot of an object

Description

This is a generic method defined at least for the FLQuant-class, but can be extended to other classes.

An FLQuant object consist of a five-dimensional array plus a character slot called units, where the units of measurement of the data can be stored. Any character string is allowed, and at present methods and functions do not make use of its content, although this might change in the future. The intention is to facilitate accurate storage of data and output.

Details

To obtain the present value of the units slot:

units
signature("FLQuant")

To set the content of the units slot:

units<-
signature("FLQuant")

Methods

signature(FLQuant)
An FLQuant

Author(s)

FLR Team

See Also

FLQuant-class

Examples

    flq <- FLQuant()
    units(flq)
    units(flq) <- "kg"

[Package FLCore version 1.1 Index]