submodel-class: Submodel class

In flr/FLa4a: A Simple and Robust Statistical Catch at Age Model

Submodel class

Description

Class definition (slots), constructors, accessors, replacement (when relevant) and common methods.

Usage

submodel(object, ...)

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

## S4 method for signature 'submodel'
params(object)

sMod(object, ...)

## S4 method for signature 'submodel'
sMod(object)

## S4 method for signature 'submodel'
iter(obj, it)

## S4 method for signature 'submodel'
propagate(object, iter, fill.iter = TRUE)

## S4 method for signature 'submodel'
formula(x)

Arguments

object	object of relevant class (see signature of method)
...	additional argument list that might never be used
obj	the object to be subset
it	iteration to be extracted
iter	the number of iterations to create
fill.iter	should the new iterations be filled with values (TRUE) or NAs (FALSE)
x	the submodel object that is to be modified

Slot

Mod

formula describing the model

params

FLPar with model parameters

vcov

array with variance covariance paramaters related to the variance model

centering

numeric value used for centering the data

distr

a character with the parameters' statistical distribution; it must match a known distribution for R (e.g. "norm" for gaussian) so that rnorm can be called

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. If an unnamed FLQuant object is provided, this is used for sizing, but not for populating any slot.

flr/FLa4a documentation built on Dec. 21, 2024, 9:28 p.m.