Skip to contents

[Stable]

Summarize a Pmetrics Cycle object

Usage

# S3 method for class 'PM_cycle'
summary(object, cycle = NULL, digits = 3, ...)

Arguments

object

A PM_cycle object

cycle

Cycle number to summarize. Default is last cycle.

digits

Number of digits to round to. Default is 3.

...

Not used.

Value

A list of class summary.PM_cycle whose elements are the last cycle values for the following fields in a PM_cycle object.

  • cycle Maximum cycle number

  • ll Log likelihood

  • aic Akaike Information Criterion

  • bic Bayesian Information Criterion

  • gamlam Value of gamma or lambda for each output equation

  • mean Normalized mean parameter values compared to initial value

  • sd Normalized standard deviation of parameter values compared to initial value

  • median Normalized median parameter values compared to initial value

Details

This is a function usually called by the $summary() method for PM_cycle objects within a PM_result to summarize final cycle statistics. The function can be called directly on a PM_cycle object. See examples.

See also

Author

Michael Neely

Examples

#'
if (FALSE) { # \dontrun{
NPex$cycle$summary() # preferred
summary(NPex$cycle) # alternative
} # }