bbmControl: bbmControl class

In flr/bbm: FLR Implementation of a Two-Stage Stock Assessment Model

bbmControl class

Description

bbmControl class is used for setting the control parameters for the bbm function.

Usage

bbmControl(object, ...)

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

Slots

g

Instantaneous rate of biomass decrease, g = M - G, for recruits (rec) and adults (adult), c(rec=numeric(1), adult=numeric(1)).

param.fix

An FLPar with value 1 if the parameter is fixed at its initial value and 0 otherwise.

Validity

Dimensions

g must be a vector of length 2 and with the names 'rec' and 'adult'

Class

param.fix must be of class FLPar

You can inspect the class validity function by using getValidity(getClassDef('bbmControl'))

Accessors

All slots in the class have accessor methods defined that allow retrieving individual slots.

Constructor

A construction method exists for this class that can take named arguments for any of its slots. All slots are then created to match the requirements of the class validity.

Author(s)

Leire Ibaibarriaga & Sonia Sanchez

See Also

bbm

Examples

# Load data
data(ane)

# Generate an object of FLPar class (different alternatives)
bbmControl()                     # empty object
slotNames(bbmControl())          # slots

bbmControl( g=c(rec=0.68, adult=0.68), param.fix=FLPar(nyear=20, nindex=3)) # setting values for the slots

# Run assessment (control must be of class bbmControl)
class(control.ane)
run <- bbm(catch.ane, indicesB=indicesB.ane, indicesP=indicesP.ane, control=control.ane, inits=inits.ane)
run

flr/bbm documentation built on Sept. 6, 2022, 8:56 p.m.