summary.corStruct            package:nlme            R Documentation

_S_u_m_m_a_r_i_z_e _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 prepares 'object' to be printed using the
     'print.summary' method, by changing its class and adding a
     'structName' attribute to it.

_U_s_a_g_e:

     ## S3 method for class 'corStruct':
     summary(object, structName, ...)

_A_r_g_u_m_e_n_t_s:

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

structName: an optional character string defining the type of
          correlation structure associated with 'object', to be used in
          the 'print.summary' method. Defaults to 'class(object)[1]'.

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

_V_a_l_u_e:

     an object identical to 'object', but with its class changed to
     'summary.corStruct' and an additional attribute 'structName'. The
     returned value inherits from the same classes as 'object'.

_A_u_t_h_o_r(_s):

     Jose Pinheiro and Douglas Bates

_E_x_a_m_p_l_e_s:

     cs1 <- corAR1(0.2)
     summary(cs1)

