summary.varFunc             package:nlme             R Documentation

_S_u_m_m_a_r_i_z_e _v_a_r_F_u_n_c _O_b_j_e_c_t

_D_e_s_c_r_i_p_t_i_o_n:

     A 'structName' attribute, with the value of corresponding
     argument, is appended to 'object' and its class is changed to
     'summary.varFunc'.

_U_s_a_g_e:

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

_A_r_g_u_m_e_n_t_s:

  object: an object inheriting from class 'varFunc', representing a
          variance function structure.

structName: an optional character string with a description of the
          'varFunc' class. Default depends on the method function:
          '"Combination of variance functions"' for 'varComb',
          '"Constant plus power of covariate"' for 'varConstPower',
          '"Exponential of variance covariate"' for 'varExp',
          '"Different standard deviations per stratum"' for 'varIdent',
          '"Power of variance covariate"' for 'varPower', and
          'data.class(object)' for 'varFunc'.

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

_V_a_l_u_e:

     an object similar to 'object', with an additional attribute
     'structName', inheriting from class 'summary.varFunc'.

_A_u_t_h_o_r(_s):

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

_S_e_e _A_l_s_o:

     'varClasses',  'varFunc'

_E_x_a_m_p_l_e_s:

     vf1 <- varPower(0.3, form = ~age)
     vf1 <- Initialize(vf1, Orthodont)
     summary(vf1)