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¶
## S4 method for signature 'lm'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'glm'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'merMod'
getSummary(obj, alpha=.05, ...)
# These are contributed by Christopher N. Lawrence
## S4 method for signature 'clm'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'polr'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'simex'
getSummary(obj, alpha=.05,...)
# These are contributed by Jason W. Morgan
## S4 method for signature 'aftreg'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'coxph'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'phreg'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'survreg'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'weibreg'
getSummary(obj, alpha=.05,...)
# These are contributed by Achim Zeileis
## S4 method for signature 'ivreg'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'tobit'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'hurdle'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'zeroinfl'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'betareg'
getSummary(obj, alpha=.05,...)
## S4 method for signature 'multinom'
getSummary(obj, alpha=.05,...)
# These are contributed by Dave Atkins
# Method for 'glm' objects - to report
# exponentiated coefficients.
getSummary_expcoef(obj, alpha=.05,...)
## S4 method for signature 'glm'
getSummary_expcoef(obj, alpha=.05,...)
Arguments¶
obj-
a model object, e.g. of class
lmorglm alpha-
level of the confidence intervals; their coverage should be 1-alpha/2
...-
further arguments; ignored.
Value¶
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:
estthe coefficient estimates,
sethe estimated standard errors,
statt- or Wald-z statistics,
psignificance levels of the statistics,
lwrlower confidence limits,
uprupper 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.
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