summary.varFunc {nlme}R Documentation

Summarize varFunc Object

Description

A structName attribute, with the value of corresponding argument, is appended to object and its class is changed to summary.varFunc.

Usage

summary(object, structName)

Arguments

object an object inheriting from class varFunc, representing a variance function structure.
structName an optional character string with a description of the varFunc class. Default depends on the method function: "Combination of variance functions" for varComb, "Constant plus power of covariate" for varConstPower, "Exponential of variance covariate" for varExp, "Different standard deviations per stratum" for varIdent, "Power of variance covariate" for varPower, and data.class(object) for varFunc.

Value

an object similar to object, with an additional attribute structName, inheriting from class summary.varFunc.

Author(s)

Jose Pinheiro and Douglas Bates

See Also

print.summary.varFunc

Examples

data(Orthodont)
vf1 <- varPower(0.3, form = ~age)
vf1 <- initialize(vf1, Orthodont)
summary(vf1)