get_sigma: Extract residual variability parameter estimates from a NONMEM output object.

Description

Extract residual variability parameter estimates from a NONMEM output object.

Usage

get_sigma(x, output = "est", sigdig = 6, sep = "-", est.step = NULL)

Value

A symmetrical matrix, or a list of symmetrical matrices if all is specified.

est returns the estimated SIGMA variance-covariance matrix. se returns the standard errors for the estimated SIGMA variance-covariance matrix. rse returns the relative standard errors for the estimated SIGMA variance-covariance matrix (se/est*100). cor returns the correlation matrix matrix. cse returns the standard errors for the correlation matrix. 95ci returns the asymptotic 95% confidence intervals for the elements of the SIGMA variance-covariance matrix (est +/- 1.96*se). all returns all available SIGMA matrices.

Arguments

x: A NONMEM output object generated using read_nm.
output: A flag specifying the matrix or matrices to be output. Valid flag values are est (the default), se, rse, cor, cse, 95ci, or all.
sigdig: Specifies the number of significant digits to be provided (default=6).
sep: Specifies the separator character to use for 95% confidence intervals (default="-").
est.step: Specifies which estimation step to return parameters from (default is the last).

Author

Justin Wilkins, justin.wilkins@occams.com

Examples

Run this code

if (FALSE) {
 nmOutput <- read_nm("run315.xml")
 sigmas   <- get_sigma(nmOutput)
 sigmaRSEs <- get_sigma(nmOutput, "rse")
}