coef.corStruct             package:nlme             R Documentation

_C_o_e_f_f_i_c_i_e_n_t_s _o_f _a _c_o_r_S_t_r_u_c_t _O_b_j_e_c_t

_D_e_s_c_r_i_p_t_i_o_n:

     This method function extracts the coefficients associated with the
     correlation structure represented by 'object'.

_U_s_a_g_e:

     ## S3 method for class 'corStruct':
     coef(object, unconstrained, ...)
     ## S3 replacement method for class 'corStruct':
     coef(object, ...) <- value

_A_r_g_u_m_e_n_t_s:

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

unconstrained: a logical value. If 'TRUE' the coefficients are returned
          in unconstrained form (the same used in the optimization
          algorithm). If 'FALSE' the coefficients are returned in
          "natural", possibly constrained, form. Defaults to 'TRUE'.

   value: a vector with the replacement values for the coefficients
          associated with 'object'. It must be a vector with the same
          length of 'coef{object}' and must be given in unconstrained
          form.

     ...: some methods for this generic require additional arguments. 
          None are used in this method.

_V_a_l_u_e:

     a vector with the coefficients corresponding to 'object'.

_S_I_D_E _E_F_F_E_C_T_S:

     On the left side of an assignment, sets the values of the
     coefficients of 'object' to 'value'. 'Object' must be initialized
     (using 'Initialize') before new values can be assigned to its
     coefficients.

_A_u_t_h_o_r(_s):

     Jose Pinheiro and Douglas Bates

_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, New York.

_S_e_e _A_l_s_o:

     'corAR1', 'corARMA', 'corCAR1', 'corCompSymm', 'corExp',
     'corGaus', 'corLin', 'corRatio', 'corSpatial', 'corSpher',
     'corSymm','Initialize'

_E_x_a_m_p_l_e_s:

     cst1 <- corARMA(p = 1, q = 1)
     coef(cst1)