getCovariate.corStruct         package:nlme         R Documentation

_E_x_t_r_a_c_t _c_o_r_S_t_r_u_c_t _O_b_j_e_c_t _C_o_v_a_r_i_a_t_e

_D_e_s_c_r_i_p_t_i_o_n:

     This method function extracts the covariate(s) associated with
     'object'.

_U_s_a_g_e:

     ## S3 method for class 'corStruct':
     getCovariate(object, form, data)

_A_r_g_u_m_e_n_t_s:

  object: an object inheriting from class 'corStruct' representing a
          correlation structure.

    form: this argument is included to make the method function
          compatible with the generic. It will be assigned the value of
          'formula(object)' and should not be modified.

    data: an optional data frame in which to evaluate the variables
          defined in 'form', in case 'object' is not initialized and
          the covariate needs to be evaluated.

_V_a_l_u_e:

     when the correlation structure does not include a grouping factor,
     the returned value will be a vector or a matrix with the
     covariate(s) associated with 'object'. If a grouping factor is
     present, the returned value will be a list of vectors or matrices
     with the covariate(s) corresponding to each grouping level.

_A_u_t_h_o_r(_s):

     Jose Pinheiro Jose.Pinheiro@pharma.novartis.com and Douglas Bates
     bates@stat.wisc.edu

_R_e_f_e_r_e_n_c_e_s:

     Pinheiro, J.C., and Bates, D.M. (2000) "Mixed-Effects Models in S
     and S-PLUS", Springer.

_S_e_e _A_l_s_o:

     'getCovariate'

_E_x_a_m_p_l_e_s:

     cs1 <- corAR1(form = ~ 1 | Subject)
     getCovariate(cs1, data = Orthodont)

