FCB: Matrix of Fishery - Catch - Biol relationships

In iagomosqueira/FLFishery: Classes and Methods for Simpler Fleet/Fishery Modelling

Matrix of Fishery - Catch - Biol relationships

Description

The relationships between a fishery, its catch elements and the biological populations that catch is taken from, is part of the 'fwdControl' class. When a single 'FLBiol' and 'FLFishery', or just an 'FLStock', are projected forward, this structure is constructed on the fly. Even when multiple biols and fisheries are used, a guess is made based on name matching.

Usage

## S4 method for signature 'ANY'
FCB(object, ...)

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

## S4 method for signature 'FLBiols'
FCB(object, fisheries)

## S4 method for signature 'FLFisheries'
FCB(object, biols)

Arguments

object	A list or vector containing a row for the matrix.
...	Further vectors to be merged into the matrix.
fisheries	An 'FLFisheries' object to extract fishery and catch names from.
biols	An 'FLBiols' object to match with 'FLCatch' elements in 'object'.

Details

But when a more complex structure is employed, the 'FCB' matrix can be given to the 'fwdControl()' constructor method. Elements in this matrix can be names or numbers.

If 'FLBiols' and 'FLFisheries' objects are passed to 'FCB', a guess is made at constructing the matrix based on the names of the various list elements.

Examples

# 1 fishery with catches from 2 biols
FCB(c(f=1, c=1, b=2), c(f=1, c=2, b=2))
# 2 fisheries with caches from 3 biols
FCB(c(f=1, c=1, b=1), c(f=1, c=2, b=2),
  c(f=2, c=1, b=2), c(f=2, c=2, b=2),
  c(f=2, c=3, b=3))

iagomosqueira/FLFishery documentation built on Nov. 10, 2023, 6:37 p.m.