FLIndex-class {FLCore}R Documentation

Class FLIndex

Description

A class designed to hold data and parameters related to abundance indices

Objects from the Class

Objects can be created by calls of the form new("FLIndex", ...), through the creator function FLIndex().

Creator Function

The function FLIndex() creates a new FLIndex object. To initialise the object, an FLQuant should be provided for the index slot. An empty FLQuant can be used to create an empty FLIndex of the right dimensions, as in

FLIndex(index=FLQuant(dim=c(5,10,1,1,1)))

Slots

Objects of the FLIndex class contain the following slots:

name:
The name of the index or fleet
desc:
Description of the index
type:
Type of abundance index as a character string
range:
Year and age range, and specified plus group age. A vector of length 5.
distribution:
A character string for the probability density function assumed for the error estructure
index:
An "FLQuant" for the index (CPUE or other) in numbers, either quant (i.e., age) structured, or not.
index.var:
An "FLQuant" for the index variance

Methods

qapply
signature(X = "FLSR", FUN = "function"): Apply a function to all FLQuant slots in an object
dims
signature(obj = "FLIndex"): ...
plot
signature(x = "FLIndex", y = "missing"): ...
summary
signature(object = "FLIndex"): ...
transform
signature(x = "FLIndex"): ...
window
signature(x = "FLIndex"): ...
trim
signature(x = "FLIndex"): ...

Author(s)

FLR Team

See Also

FLIndices-class

Examples

fi <- FLIndex(name = 'index', desc = 'An index', index=FLQuant(dim=c(5,10,1,1,1)))
summary(fi)

[Package FLCore version 1.4-3 Index]