getOFCs: Get model components in the objective function as a...

Description Usage Arguments Details Value

View source: R/getOFCs.R

Description

Function to get model components in the objective function as a tcsam02.ofc (melted dataframe) object.

Usage

1
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 Dec. 7, 2018, 7:58 a.m.