VarCorr                 package:lme4                 R Documentation

_E_x_t_r_a_c_t _v_a_r_i_a_n_c_e _a_n_d _c_o_r_r_e_l_a_t_i_o_n _c_o_m_p_o_n_e_n_t_s

_D_e_s_c_r_i_p_t_i_o_n:

     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.

_U_s_a_g_e:

     ## S4 method for signature 'mer':
     VarCorr(x, REML = x@status["REML"], ...)
     ## S4 method for signature 'mer2':
     VarCorr(x, REML = NULL, ...)

_A_r_g_u_m_e_n_t_s:

       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.

_V_a_l_u_e:

     an object of class 'VarCorr'.

_S_e_e _A_l_s_o:

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

_E_x_a_m_p_l_e_s:

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

