as.FLQuant {FLCore}R Documentation

as.FLQuant

Description

Creates from other objects or tests for an FLQuant

Usage

   as.FLQuant(x, ...)
   is.FLQuant(x)

Arguments

x For as.FLQuant matrix, numeric vector, array, data.frame or FLQuant. For is.FLQuant, any R object.
... Extra arguments, including dim, dimnames, quant, and units. Deafults to dimnames = "missing", units = "NA", quant = NULL

Details

as.FLQuant can be used to alter the dimnames and/or units of an FLQuant, although other methods exist for this. If x is a matrix, it is considered to be a year-by-age matrix, and all other dimensions will be considered singular. Ages and years are taken from the matrix row and columns names, respectively, if those exist.

To coerce a numeric vector, Dimnames needs to be specified, in order to indicate along which dimension does the vector run.

When x is a data.frame, columns should have names corresponding to the FLQuant dimensions, while the last column (usually named Freq) holds the data.

Finally, if x is an array, its dimensions should not exceeded those of an FLQuant (five). If the array dimensions are less than five, all other dimensions will be considered unique. Dimnames of the array must also match those of an FLQuant with the same dimensions.

Value

as.FLQuant returns an FLQuant object with original data converted. is.FLQuant returns 'TRUE' if it is an FLQuant object, 'FALSE' otherwise.

Author(s)

FLR Team

See Also

FLQuant-class, units

Examples

# Generate an array containing random numbers, and convert it into an FLQuant
sq <- FLQuant(array(rnorm(120, mean=2), dim=c(20,3,2,1,1),
      dimnames=list(age=as.character(1:20), 
                    year=c("1999", "2000", "2001"), 
                    unit=c("male", "female"), 
                    season="all", area="all")), units="Tons")
summary(sq)

# as.FLQuant
arr <- array(rnorm(24), dim=c(3, 4, 2))
class(arr)
flq <- as.FLQuant(arr, units='kg')
summary(flq)
class(flq)

is.FLQuant(flq)        # Yes

[Package FLCore version 1.1 Index]