Can be used to either get a parameter list object from a mrgmod
model object or to update the parameters in a model object.
For both uses, the return value is a parameter_list
object. For the
former use, param()
is usually called to print the parameters to the
screen, but the parameter_list
object can also be coerced to a list
or numeric R object.
Use allparam()
to get a parameter_list
object including
both model parameters and data items listed in $FIXED
.
The update to parameters can be permissive (candidates with names that don't
exist in the parameter list are silently ignored) or strict (all candidates
must already exist in the parameter list). When passing candidate values
via ...
, the update is strict and an error is generated if you pass a
name that isn't found in the parameter list. When candidate values
are passed as a named object via .y
, then the update is permissive. Any
permissive update can be made strict (error if foreign names are found in
the candidates) by passing .strict = TRUE
.
An alternative is to assess the incoming names using inventory()
.