FLIndex {FLCore} | R Documentation

## Class FLIndex

### Description

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

### Slots

type
  (`character`) Type of index
distribution
  (`character`): Statistical distribution of the index values
index
  (`FLQuant`): Index values
index.var
  (`FLQuant`): Variance of the index
catch.n
  (`FLQuant`): Catch numbers used to create the index
catch.wt
  (`FLQuant`): Catch weight of the index
effort
  (`FLQuant`): Effort used to create the index
sel.pattern
  (`FLQuant`): Selection pattern for the index
index.q
  (`FLQuant`): Catchability of the index
name
  (`character`): Name of the stock inherited from FLComp-class
desc
  (`character`): General description of the object inherited from FLComp-class
range
  (`numeric`):
{Range of the object inherited from FLComp-class}

### Extends

FLComp

### Methods

catch.n(FLCore) :
  Accessor for the catch.n slot in the object
  `signature(object=missing)`
catch.n<-(FLCore) :
  Replacement function for the catch.n slot in the object
  `signature(object=FLIndex,value=FLQuant)`
catch.wt(FLCore) :
  Accessor for the catch.n slot in the object
  `signature(object=missing)`
catch.wt<-(FLCore) :
  replacement function for the catch.wt slot in the object
  `signature(object=FLIndex,value=FLQuant)`
coerce(methods) :
  Describe method
  `signature(from=NULL,to=FLIndex,strict=missing)`
computeCatch(FLCore) :
  Compute the catch in the FLIndex method, as catch.n and catch.wt
  `signature(object=missing)`
dims(FLCore) :
  returns the dims of the objects
  `signature(obj=missing)`
iter(FLCore) :
  To extract or modify a subset of the iterations contained in the FLIndex object, the `iter` and `iter<-` methods can be used
  `signature(object=missing)`
plot(graphics) :
  Plot the FLIndex-class, takes an additional argument type, which defines the type of plot
  `signature(x=FLIndex,y=missing)`
propagate(FLCore) :
  `FLIndex` objects with a single iteration (length of 1 in the sixth dimension) can be extended using the `propagate` method. The `type` argument selects whether the new iterations are filled with the content of the first iteration (`type='all'`) or left empty (`type='first'`)
  `signature(object=missing)`
summary(base) :
  summary is a generic function used to produce result summaries of the `FLIndex`
  `signature(object=missing)`
transform(base) :
  Transform allows to change a number of slots of class FLQuant to be changed at once
  `signature(_data=missing)`
trim(FLCore) :
  Subsetting of FLIdex object can be carried out using the dimension names by using `trim`. A number of dimension names and selected dimensions are passed to the method and those are used to subset the input object.
  `signature(object=missing)`
window(stats) :
  This method extracts a section of or extends the FLInedex object along the `year` dimension. If a frequency is specified, the new object contains data at only those year steps.
  `signature(x=missing)`

### Author(s)

The FLR Team

### See Also

catch.n, catch.n<-, catch.wt, catch.wt<-, coerce, computeCatch, dims, iter, plot, propagate, summary, transform, trim, window, FLComp

[Package FLCore version 2.2 Index]