Learn R Programming

nlme (version 3.1-68.1)

summary.pdMat: Summarize a pdMat Object

Description

Attributes structName and noCorrelation, with the values of the corresponding arguments to the method function, are appended to object and its class is changed to summary.pdMat.

Usage

## S3 method for class 'pdMat':
summary(object, structName, noCorrelation, \dots)

Arguments

object
an object inheriting from class pdMat, representing a positive definite matrix.
structName
an optional character string with a description of the pdMat class. Default depends on the method function: "Blocked" for pdBlocked, "Compound Symmetry" for pdCompSymm, "Diago
noCorrelation
an optional logical value indicating whether correlations are to be printed in print.summary.pdMat. Default depends on the method function: FALSE for pdDiag and pdIdent, and TRUE fo
...
some methods for this generic require additional arguments. None are used in this method.

Value

  • an object similar to object, with additional attributes structName and noCorrelation, inheriting from class summary.pdMat.

See Also

print.summary.pdMat, pdMat

Examples

Run this code
summary(pdSymm(diag(4)))

Run the code above in your browser using DataLab