Submodels class

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

submodels(...)

submodels(...)

corBlocks(object, ...)

# S4 method for submodels
corBlocks(object)

# S4 method for submodels
params(object)

# S4 method for submodels
sMod(object)

# S4 method for submodels
formula(x)

corBlocks(object, ...) <- value

# S4 method for submodels,list
corBlocks(object, ...) <- value

# S4 method for submodels,submodel
$(x, name) <- value

# S4 method for submodels,character,missing
[[(x, i, j, ...) <- value

# S4 method for submodels,numeric,missing
[[(x, i, j, ...) <- value

# S4 method for submodels
propagate(object, iter, fill.iter = TRUE)

# S4 method for submodels
iter(obj, it)

Arguments

...

additional argument list that might never be used

object

object of relevant class (see signature of method)

x

object to be modified

value

value the new object

name

name(s) of entry to be extracted / modified

i, j

indices specifying elements to extract or replace.

iter

the number of iterations to create

fill.iter

should the new iterations be filled with values (TRUE) or NAs (FALSE)

obj

the object to be subset

it

iteration to be extracted

Note

This class is similar to other 'plural' calsses in FLR. It is a list constrained to having all elements of the same class, in this case submodel. Otherwise it works exacly as any other list.

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.