getOFCs: Get model components in the objective function as a...
In wStockhausen/rTCSAM02: A set of tools to set up input for, and interact with output from, TCSAM02 model runs
getOFCs R Documentation
Get model components in the objective function as a tcsam02.ofc (melted dataframe) object
Description
Function to get model components in the objective function as a tcsam02.ofc (melted dataframe) object.
Usage
getOFCs(obj, mdl = NULL, verbose = FALSE)
Arguments
obj
a single tcsam02 rep object, a single tcsam02 resLst object, or a named list of such
mdl
name to associate with model results object
verbose
flag (T/F) to print diagnostic info
Details
If obj is a list of tcsam02 resLst (tcsam.resLst) or rep (tcsam02.rep) objects, then the function
is called recursively for each object, with the associated list component name used as
mdl. If obj is a tcsam02 resLst or rep object and mdl is NULL (the default), then
the configName is used as the model name.
The returned dataframe has columns named
"model", "type", "category", "name", "level", "variable", and "value".
The "variable" column indicates whether the "value" is a weight ('wgt'),
negative log-likelihood ('nll'), or objective function value ('objfun').
Value
a melted dataframe with class tcsam02.ofc
wStockhausen/rTCSAM02 documentation built on April 16, 2024, 6:25 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| getOFCs | R Documentation |
Get model components in the objective function as a tcsam02.ofc (melted dataframe) object
Description
Function to get model components in the objective function as a tcsam02.ofc (melted dataframe) object.
Usage
getOFCs(obj, mdl = NULL, verbose = FALSE)
Arguments
obj |
|
mdl |
|
verbose |
|
Details
If obj is a list of tcsam02 resLst (tcsam.resLst) or rep (tcsam02.rep) objects, then the function is called recursively for each object, with the associated list component name used as mdl. If obj is a tcsam02 resLst or rep object and mdl is NULL (the default), then the configName is used as the model name.
The returned dataframe has columns named "model", "type", "category", "name", "level", "variable", and "value".
The "variable" column indicates whether the "value" is a weight ('wgt'), negative log-likelihood ('nll'), or objective function value ('objfun').
Value
a melted dataframe with class tcsam02.ofc
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.