nlme: summary.corStruct – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

summary.corStruct

Summarize a corStruct Object

Description

This method function prepares object to be printed using the print.summary method, by changing its class and adding a structName attribute to it.

Usage

## S3 method for class 'corStruct'
summary(object, structName, ...)

Arguments

`object`	an object inheriting from class `"corStruct"`, representing a correlation structure.
`structName`	an optional character string defining the type of correlation structure associated with `object`, to be used in the `print.summary` method. Defaults to `class(object)[1]`.
`...`	some methods for this generic require additional arguments. None are used in this method.

Value

an object identical to object, but with its class changed to summary.corStruct and an additional attribute structName. The returned value inherits from the same classes as object.

Author(s)

José Pinheiro and Douglas Bates

Examples

cs1 <- corAR1(0.2)
summary(cs1)

nlme

Linear and Nonlinear Mixed Effects Models

v3.1-152

GPL (>= 2) | file LICENCE

Authors

José Pinheiro [aut] (S version), Douglas Bates [aut] (up to 2007), Saikat DebRoy [ctb] (up to 2002), Deepayan Sarkar [ctb] (up to 2005), EISPACK authors [ctb] (src/rs.f), Siem Heisterkamp [ctb] (Author fixed sigma), Bert Van Willigen [ctb] (Programmer fixed sigma), Johannes Ranke [ctb] (varConstProp()), R-core [aut, cre]

Initial release

2021-02-03