coef.varFunc              package:nlme              R Documentation

_v_a_r_F_u_n_c _O_b_j_e_c_t _C_o_e_f_f_i_c_i_e_n_t_s

_D_e_s_c_r_i_p_t_i_o_n:

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

_U_s_a_g_e:

     ## S3 method for class 'varFunc':
     coef(object, unconstrained, allCoef, ...)
     ## S3 method for class 'varIdent':
     coef(object, ...) <- value

_A_r_g_u_m_e_n_t_s:

  object: an object inheriting from class 'varFunc' representing a
          variance function 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", generally constrained form. Defaults to 'TRUE'.

 allCoef: a logical value. If 'FALSE' only the coefficients which may
          vary during the optimization are returned. If 'TRUE' all
          coefficients are returned. Defaults to 'FALSE'.

   value: a vector with the replacement values for the coefficients
          associated with 'object'. It must be have the same length of
          'coef{object}' and must be given in unconstrained form.
          'Object' must be initialized before new values can be
          assigned to its coefficients.

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

_A_u_t_h_o_r(_s):

     Jose Pinheiro and Douglas Bates

_S_e_e _A_l_s_o:

     'varFunc'

_E_x_a_m_p_l_e_s:

     vf1 <- varPower(1)
     coef(vf1)
     coef(vf1) <- 2

