FCB {FLasher}

R Documentation

Create and extract the FCB slot in fwdControl

Description

The FCB slot in fwdControl specifies the relationships between the catches ('C') taken by each fishery ('F') from different biological units ('B').

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

FCB(object, ...)

FCB(object, ...) <- value

## S4 method for signature 'fwdControl'
FCB(object)

## S4 replacement method for signature 'fwdControl,matrix'
FCB(object) <- value

## 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.
value	Input matrix
fisheries	An 'FLFisheries' object to extract fishery and catch names from.
biols	An 'FLBiols' object to match with 'FLCatch' elements in 'object'.

Details

This slot is of class *matrix* and has thre columns, named 'F', 'C' and 'B', and as many rows as relationships between the FLBiol(s) and FLFishery(ies) objects the fwdControl refers to.

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

control <- fwdControl()
# Access FCB slot
FCB(control)
# Assign to existing fwdControl
FCB(control) <- FCB(c(f=1, c=1, b=2), c(f=1, c=2, b=2))
# 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))

---