getSummary              package:memisc              R Documentation

_G_e_t _M_o_d_e_l _S_u_m_m_a_r_i_e_s _f_o_r _U_s_e _w_i_t_h "_m_t_a_b_l_e"

_D_e_s_c_r_i_p_t_i_o_n:

     A generic function and methods to collect coefficients and summary
     statistics from a model object. It is used in 'mtable'

_U_s_a_g_e:

       ## S3 method for class 'lm':
       getSummary(obj, alpha=.05,...)
       ## S3 method for class 'glm':
       getSummary(obj, alpha=.05,...)

_A_r_g_u_m_e_n_t_s:

     obj: a model object, e.g. of class 'lm' or 'glm'

   alpha: level of the confidence intervals; their coverage should be
          1-alpha/2 

     ...: further arguments; ignored.

_D_e_t_a_i_l_s:

     The generic function 'getSummary' is called by 'mtable' in order
     to obtain the coefficients and summaries of model objects. In
     order to adapt 'mtable' to models of classes other than 'lm' or
     'glm' one needs to define 'getSummary' methods for these classes
     and to set a summary template via 'setSummaryTemplate'

_V_a_l_u_e:

     Any method of 'getSummary' must return a list with the following
     components:

    coef: an array with coefficient estimates; the lowest dimension
          _must_ have the following names and meanings:

             'est'    the coefficient estimates,
              'se'    the estimated standard errors,
            'stat'    t- or Wald-z statistics,
               'p'    significance levels of the statistics,
             'lwr'    lower confidence limits,
             'upr'    upper confidence limits.

          The higher dimensions of the array correspond to the
          individual coefficients and, in multi-equation models, to the
          model equations.

 sumstat: a vector containing the model summary statistics; the
          components may have arbitrary names.

