predictModel: A class for model prediction

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

A class for model prediction

Description

Object of the predictModel class are used in various FLR classes to allow flexible modelling of the dynamics of different biological and technological processes.

Usage

## S4 method for signature 'FLQuants,formula'
predictModel(object, model, params = FLPar())

## S4 method for signature 'FLQuants,missing'
predictModel(object, params = FLPar())

## S4 method for signature 'FLQuants,character'
predictModel(object, model, params = FLPar())

## S4 method for signature 'FLQuants,function'
predictModel(object, model, params = FLPar())

## S4 method for signature 'FLQuants,list'
predictModel(object, model, params = FLPar())

## S4 method for signature 'missing,ANY'
predictModel(object, model, ...)

Details

The dependency of life history processes, such as maturity and fecundity, to biological and environmental factors, can be represented in objects of this class via a simple model (represented by a formula) and the corresponding paramaters (FLPar) and inputs (FLQuants).

Slots

.Data

Inputs to the model not found in enclosing class (FLQuants).

model

Model representation (formula).

params

Model paramaters (FLPar).

Validity

VALIDITY

Neque porro quisquam est qui dolorem ipsum.

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

Accessors

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

The values passed for replacement need to be of the class of that slot. A numeric vector can also be used when replacing FLQuant slots, and the vector will be used to substitute the values in the slot, but not its other attributes.

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.

Methods

Methods exist for various calculations based on values stored in the class:

METHOD

Neque porro quisquam est qui dolorem ipsum.

Author(s)

The FLR Team

See Also

FLQuants FLPar FLBiol

Examples

fec <- FLQuants(fec=FLQuant(rlnorm(10, 20, 5),
  dimnames=list(year=2000:2009), units='1'))
predictModel(fec, model=~fec)
predictModel(fec)
predictModel(fec, model="bevholt")
predictModel(fec, model=bevholt)
predictModel(fec, model=bevholt())
predictModel(model=rec~a*ssb, params=FLPar(a=1.234))
predictModel(model=bevholt, params=FLPar(a=1.234))
predictModel(model="bevholtss3", params=FLPar(a=1.234))

flr/FLCore documentation built on May 4, 2024, midnight