getObjFunValues.Penalties: Get model penalties in the objective function as a melted...

In wStockhausen/rTCSAM2015: A set of tools to set up input for, and interact with output from, a TCSAM2015 model run, as well as to compare TCSAM2015 and rsimTCSAM runs.

Description

Function to get model penalties as a melted dataframe.

Usage

getObjFunValues.Penalties(repObjs, mdl = NULL, verbose = FALSE)

Arguments

repObjs	- tcsam2015.rep model results object or list of such
mdl	- name to associate with model results object
verbose	- flag (T/F) to print diagnostic info

Details

If repObjs is a list of tcsam2015 model results objects, then the function is called recursively for each object, with the associated list component name used as mdl. If repObjs is a tcsam2015 model results object and mdl is NULL (the default), then repObjs$mc$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

wStockhausen/rTCSAM2015 documentation built on May 3, 2019, 7:14 p.m.