getSummary: Get Model Summaries for Use with "mtable"

Description

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

Usage

## S3 method for class 'lm':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'glm':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'merMod':
getSummary(obj, alpha=.05, varPar.as.coef = TRUE, \dots)
  # These are contributed by Christopher N. Lawrence
  ## S3 method for class 'clm':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'polr':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'simex':
getSummary(obj, alpha=.05,\dots)
  # These are contributed by Jason W. Morgan
  ## S3 method for class 'aftreg':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'coxph':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'phreg':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'survreg':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'weibreg':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'mer':
getSummary(obj, alpha=.05, varPar.as.coef = TRUE, \dots)
  # These are contributed by Achim Zeileis
  ## S3 method for class 'ivreg':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'tobit':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'hurdle':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'zeroinfl':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'betareg':
getSummary(obj, alpha=.05,\dots)
  ## S3 method for class 'multinom':
getSummary(obj, alpha=.05,\dots)
  
  # These are contributed by Dave Atkins
  # Method for 'glm' objects - to report
  # exponentiated coefficients.
  getSummary_expcoef(obj, alpha=.05,...)
  ## S3 method for class 'glm':
getSummary_expcoef(obj, alpha=.05,\dots)

Arguments

obj

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

alpha

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

varPar.as.coef

logical; should variance parameters included into the table of coefficients?

...

further arguments; ignored.

Value

Any method of getSummary must return a list with the following components:
coefan array with coefficient estimates; the lowest dimension must have the following names and meanings: rcl{ 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.
sumstata vector containing the model summary statistics; the components may have arbitrary names.

Details

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