ranef

0th

Percentile

Extract Random Effects

A generic function to extract, and optionally accumulate, the random effects.

Keywords
models, methods
Usage
ranef(object, ...)
## S3 method for class 'lmer':
ranef(object, postVar, \dots)
## S3 method for class 'lmer2':
ranef(object, postVar, \dots)
Arguments
object
an object of a class from which random effects estimates can be extracted.
postVar
an optional logical argument indicating if the conditional variance covariance matrices, also called the posterior variances, of the random effects should be included. Default is FALSE.
...
some methods for this generic function require additional arguments.
Details

If grouping factor i has k levels and j random effects per level the ith component of the list returned by ranef is a data frame with k rows and j columns. If postVar is TRUE the "postVar" attribute is an array of dimension j by j by k. The kth face of this array is a positive definite symmetric j by j matrix. If there is only one grouping factor in the model the variance-covariance matrix for the entire random effects vector, conditional on the estimates of the model parameters and on the data will be block diagonal and this j by j matrix is the kth diagonal block. With multiple grouping factors the faces of the "postVar" attributes are still the diagonal blocks of this conditional variance-covariance matrix but the matrix itself is no longer block diagonal.

Value

  • A list of data frames, one for each grouping factor for the random effects. The number of rows in the data frame is the number of levels of the grouping factor. The number of columns is the dimension of the random effect associated with each level of the factor.

    If postVar is TRUE each of the data frames has an attribute called "postVar" which is a three-dimensional array with symmetric faces.

Note

To produce a caterpillar plot of the random effects apply qqmath to the result of ranef with postVar = TRUE.

Aliases
  • ranef
  • ranef-methods
  • ranef,ANY-method
  • ranef,lmer-method
  • ranef,mer-method
  • ranef,lmer2-method
Examples
fm1 <- lmer(Reaction ~ Days + (Days|Subject), sleepstudy)
fm2 <- lmer(Reaction ~ Days + (1|Subject) + (0+Days|Subject), sleepstudy)
ranef(fm1)
str(rr1 <- ranef(fm1, postVar = TRUE))
qqmath(rr1)
str(ranef(fm2, postVar = TRUE))
Documentation reproduced from package lme4, version 0.99875-8, License: GPL version 2 or later

Community examples

Looks like there are no examples yet.