FLIndex-class {FLCore} | R Documentation |
A class designed to hold data and parameters related to abundance indices
Objects can be created by calls of the form new("FLIndex", ...)
, through the creator function FLIndex()
.
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)))
By using the class
argument, objects can be created of the derived FLIndex classes. This can
also be achieved by using the corresponding creator functions: FLIndexCom()
,
FLIndexSurvey()
and FLIndexAcoustic()
.
Objects of the FLIndex class contain the following slots:
name
:desc
:range
:distribution
:index
:"FLQuant"
for the index (CPUE or other) in numbers, either quant
(i.e., age) structured, or not.index.var
:"FLQuant"
for the index variance
The FLIndexCom
class, designed for indices based on commercial catch data, adds the
following slots:
catch
:"FLQuant"
for the catchcatch.wt
:"FLQuant"
for the weight-at-age (or length) in the catcheffort
:"FLQuant"
for the effort time series. The units
slot should
indicate the units used to measure it (days, hooks per line,...)sel.pattern
:"FLQuant"
for the selection pattern.index.q
:"FLQuant"
for the index catchability.
The FLIndexSurvey
class, designed for indices based on catch surveys, adds the
following slots:
catch.n
:"FLQuant"
for the catch by age or quantcatch.wt
:"FLQuant"
for the weight-at-age (or length) in the catcheffort
:"FLQuant"
for the effort time series. The units
slot should
indicate the units used to measure it (days, hooks per line,...)index.q
:"FLQuant"
for the index catchability.
The FLIndexAcoustic
class, designed for indices based on acoustic surveys, adds the
following slots to be basic class:
index.q
:"FLQuant"
for the index catchability.signature(X = "FLIndex", MARGIN = "list", FUN = "function")
: ... signature(obj = "FLIndex")
: ... signature(x = "FLIndex", y = "missing")
: ... signature(object = "FLIndex")
: ... signature(x = "FLIndex")
: ... signature(x = "FLIndex")
: ... FLR Team
fi <- FLIndex(name = 'index', desc = 'An index', index=FLQuant(dim=c(5,10,1,1,1))) summary(fi) fi <- FLIndex(name = 'index', desc = 'An index', index=FLQuant(dim=c(5,10,1,1,1)), class="FLIndexCom") summary(fi)