lme4 (version 0.99875-2)

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@status["REML"], \dots)
## S3 method for class 'lmer2':
VarCorr(x, REML = NULL, \dots)
## S3 method for class 'nlmer':
VarCorr(x, \dots)

Arguments

x

a fitted model object, usually an object inheriting from class lmer (or, temporarily, class lmer2).

REML

logical indicating if REML should be 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

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