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 mixed-effects model,
     of class 'mer'.

     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, ...)
     ## S4 method for signature 'merMCMC':
     VarCorr(x, type = c("raw", "varcov", "sdcorr", "logs"), ...)

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

       x: a fitted model object, usually an object inheriting from
          class 'mer'. 

    type: character string indicating the type of result to be
          returned, either '"raw"', the raw representation as in the
          'ST' slot of the 'mer' class, or '"varcov"', variances and
          covariances, or '"sdcorr"', standard deviations and
          correlations, or '"logs"', logs of the standard deviations
          and Fisher's z transformation of the correlations.

     ...: 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 'mer' 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))

