getModelCov: Utility Function for RRPP

In RRPP: Linear Model Evaluation with Randomized Residuals in a Permutation Procedure

Utility Function for RRPP

Description

A function mostly for internal processing but can be used to extract either the model covariance matrix (Cov) or the projection matrix for transformations made from the covariance matrix (Pcov), which is basically the square-root of the covariance matrix. This matrix is the model covariance used for estimation, not the residual covariance matrix (see getResCov). There are also options for S3 or S4 format versions, or a forcing of symmetry for Pcov.

Usage

getModelCov(
  fit,
  type = c("Cov", "Pcov"),
  format = c("S3", "S4"),
  forceSym = TRUE
)

Arguments

fit	Object from lm.rrpp
type	Whether the Cov or Pcov matrix is returned
format	Whether an S3 or S4 format is returned
forceSym	Logical value for whether a symmetric matrix should be returned for Pcov, even if Pcov was triangular as a solution.

Author(s)

Michael Collyer

RRPP documentation built on June 22, 2024, 6:45 p.m.