https://github.com/cran/Matrix
Tip revision: 40bc650321eaf15eda2468441954ecd0a4f68df3 authored by Douglas Bates on 07 August 2006, 00:00:00 UTC
version 0.995-14
version 0.995-14
Tip revision: 40bc650
VarCorr.Rd
\name{VarCorr}
\docType{genericFunction}
\alias{VarCorr}
\alias{VarCorr,mer-method}
\title{Extract variance and correlation components}
\usage{
\S4method{VarCorr}{mer}(x, REML = x@method == "REML", useScale = x@useScale, \dots)
}
\arguments{
\item{x}{a fitted model object, usually an object inheriting from
class \code{\linkS4class{lmer}}.
}
\item{REML}{logical indicating if REML should be used.}
\item{useScale}{logical indicating if a scale should be computed and
used; otherwise \code{sc <- 1} is used.}
\item{\dots}{Additional, optional arguments for some methods. At
present none are used.}
}
\description{
Extract the estimated variances, standard
deviations, and correlations of the random-effects terms in a
linear mixed-effects model, of class \code{lme}, or a generalized
linear mixed-effects model. When appropriate,
the within-group error variance and standard deviation are also
calculated.
}
\value{
an object of class \code{VarCorr}.
}
\seealso{
the \code{\link{lmer}} function and \code{\linkS4class{lmer}} class;
the result class \code{\linkS4class{VarCorr}}.
}
\examples{
data(sleepstudy)
(fm2 <- lmer(Reaction ~ Days + (1|Subject) + (0+Days|Subject),
data = sleepstudy))
(VC <- VarCorr(fm2))
}
\keyword{models}