nlme.extract: Extract information from nlme object

In qPharmetra/qpToolkit: qPharmetra R Tools

Extract information from nlme object

Description

Given an nlme object, extract all available information for further processing. In addition parse the information into a ready-to-use parameter estimate table. Furthermore, when method is set to samples, it will create samples to be used for a VPC (see nlme.vpc).

Usage

## S3 method for class 'extract'
nlme(
  obj,
  method = "components",
  newdata = NULL,
  sample = FALSE,
  digits = 3,
  digits.CV = 0
)

Arguments

obj	an nlme object
method	can be either components (extracting function) or samples (for VPC)
newdata	a new data set with at the minimum the data items (independent, dependent variables, covariates, and grouping variables) required to build the nlme object.
sample	logical (default is FALSE) indicating whether to sample or not
digits	number of significant digits for parameter estimate table
digits.CV	number of significant digits for coefficient of variation in the parameter estimate table

Value

list with extracted nlme object information, model summary, model parameter table, or, when method = "samples", a matrix with predictions for data.frame getData(obj) or newdata.

See Also

nlme.run, nlme.diag, nlme.vpc, nlme.simPars, nlme.getFixPars, nlme.getRanPars

Examples

fm1 <- nlme::nlme(height ~ SSasymp(age, Asym, R0, lrc),
data = Loblolly,
fixed = Asym + R0 + lrc ~ 1,
random = Asym ~ 1,
start = c(Asym = 103, R0 = -8.5, lrc = -3.3))
fm1.out = nlme.extract(fm1)
fm1.out

qPharmetra/qpToolkit documentation built on May 24, 2023, 8:52 a.m.