Matrix (version 0.995-15)

VarCorr: Extract variance and correlation components

Description

Extract the estimated variances, standard deviations, and correlations of the random-effects terms in a linear mixed-effects model, of class lme, or a generalized linear mixed-effects model. When appropriate, the within-group error variance and standard deviation are also calculated.

Usage

## S3 method for class 'mer':
VarCorr(x, REML = x@method == "REML", useScale = x@useScale, \dots)

Arguments

x

a fitted model object, usually an object inheriting from class lmer.

REML

logical indicating if REML should be used.

useScale

logical indicating if a scale should be computed and used; otherwise sc <- 1 is used.

...

Additional, optional arguments for some methods. At present none are used.

Value

• an object of class VarCorr.

See Also

the lmer function and lmer class; the result class VarCorr.

Examples

data(sleepstudy)
(fm2 <- lmer(Reaction ~ Days + (1|Subject) + (0+Days|Subject),
             data = sleepstudy))
(VC <- VarCorr(fm2))