| eicm.options {eicm} | R Documentation |
Set EICM fitting options
Description
Construct a EICM options object to inform the fitting engine. There is usually no need to use this function directly.
Usage
eicm.options(...)
Arguments
... |
a named list of options. See details. |
Details
Possible options are currently: mask and offset. Both are lists having the same structure of an eicm.matrix object:
- $mask
Binary matrices defining which coefficients are to be estimated in model fitting OR a scalar, constant for all coefficients. 0 or FALSE exclude the given term from estimation, i.e., fixes it at 0.
- $mask$env
environmental coefficient mask
- $mask$sp
species interaction mask
- $offset
Numeric matrices defining constant terms, to be fixed and not estimated
- $offset$env
environmental coefficient offset
- $offset$sp
species interaction offset
When an offset for a term is nonzero, the respective mask element will be automatically zeroed (so it is not estimated).
Value
A eicm.options object with options for model fitting, currently a model mask and model offsets.