summary.covfm: Summary Method

View source: R/summary.covfm.q

summary.covfmR Documentation

Summary Method

Description

The generic summary method for objects of class "covClassic", "covRob", and "covfm".

Usage

## S3 method for class 'covClassic'
summary(object, ...)
## S3 method for class 'covRob'
summary(object, ...)
## S3 method for class 'covfm'
summary(object, ...)

Arguments

object

an object of class "covClassic", "covRob", or "covfm".

...

additional arguments for the summary method.

Value

an object of class "summary.covClassic", "summary.covRob", or "summary.covfm" respectively. Objects of class "summary.cov" and "summary.covRob" have the following components. Objects of class "summary.covfm" are lists whose elements are "summary.cov" and "summary.covRob" objects.

call

an image of the call that produced the object with all the arguments named.

cov

a numeric matrix containing the estimate of the covariance/correlation matrix.

center

a numeric vector containing the estimate of the location vector.

evals

a numeric vector containing the eigenvalues of the covariance/correlation matrix.

dist

a numeric vector containing the Mahalanobis distances. Only present if distance = TRUE in the call.

corr

a logical flag. If corr = TRUE then cov contains an estimate of the correlation matrix of x.

See Also

summary, covClassic, covRob, fit.models.

Examples

  data(woodmod.dat)
  woodm.cov <- covClassic(woodmod.dat)
## IGNORE_RDIFF_BEGIN
  summary(woodm.cov)
## IGNORE_RDIFF_END

  woodm.covRob <- covRob(woodmod.dat)
  summary(woodm.covRob)

  woodm.fm <- fit.models(list(Robust = "covRob", Classical = "covClassic"),
                         data = woodmod.dat)
  summary(woodm.fm)

robust documentation built on Sept. 11, 2024, 5:16 p.m.