FLIndex: Class FLIndex

In flr/FLCore: Core Package of FLR, Fisheries Modelling in R

Class FLIndex

Description

A class for modelling abundance indices.

Usage

FLIndex(object, ...)

## S4 method for signature 'FLQuant'
FLIndex(object, plusgroup = dims(object)$max, ...)

## S4 method for signature 'missing'
FLIndex(object, ...)

Details

The FLIndex object holds data and parameters related to abundance indices.

Slots

type

Type of index (character).

distribution

Statistical distribution of the index values (character).

index

Index values (FLQuant).

index.var

Variance of the index (FLQuant).

catch.n

Catch numbers used to create the index (FLQuant).

catch.wt

Catch weight of the index (FLQuant).

effort

Effort used to create the index (FLQuant).

sel.pattern

Selection pattern for the index (FLQuant).

index.q

Catchability of the index (FLQuant).

name

Name of the stock (character).

desc

General description of the object (character).

range

Named numeric vector containing the quant and year ranges, the plusgroup, and the period of the year, expressed as proportions of a year, that corresponds to the index (numeric).

Author(s)

The FLR Team

See Also

computeCatch, dims, iter, plot, propagate, summary, transform, trim, window, FLComp

Examples

# Create an FLIndex object.
fli <- FLIndex(index=FLQuant(rnorm(8), dim=c(1,8)), name="myTestFLindex")
summary(fli)
index(fli)

# Creat an FLIndex object using an existing FLQuant object.
  data(ple4)
  # Create a perfect index of abundance from abundance at age
    fli2 <- FLIndex(index=stock.n(ple4))
  # Add some noise around the signal
    index(fli2) <- index(fli2)*exp(rnorm(1, index(fli2)-index(fli2), 0.1))

flr/FLCore documentation built on March 2, 2025, 12:18 a.m.