1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
\name{mtable}
\alias{mtable}
\alias{relabel.memisc_mtable}
\alias{format.memisc_mtable}
\alias{print.memisc_mtable}
\alias{write.mtable}
\alias{toLatex.memisc_mtable}
\alias{dim.memisc_mtable}
\alias{dimnames.memisc_mtable}
\alias{[.memisc_mtable}
\alias{c.memisc_mtable}
\title{Comparative Table of Model Estimates}
\description{
\code{mtable} produces a table of estimates for several models.
}
\usage{
mtable(\dots,coef.style=getOption("coef.style"),
summary.stats=TRUE,
signif.symbols=getOption("signif.symbols"),
factor.style=getOption("factor.style"),
show.baselevel=getOption("show.baselevel"),
baselevel.sep=getOption("baselevel.sep"),
getSummary=eval.parent(quote(getSummary)),
float.style=getOption("float.style"),
digits=min(3,getOption("digits")),
sdigits=digits,
show.eqnames=getOption("mtable.show.eqnames",NA),
gs.options=NULL,
controls=NULL,
collapse.controls=FALSE,
control.var.indicator=getOption("control.var.indicator",c("Yes","No"))
)
\method{relabel}{memisc_mtable}(x, \dots, gsub = FALSE, fixed = !gsub, warn = FALSE)
\method{format}{memisc_mtable}(x,target=c("print","LaTeX","HTML","delim"),
\dots
)
\method{print}{memisc_mtable}(x,
center.at=getOption("OutDec"),
topsep="=",bottomsep="=",sectionsep="-",\dots)
write.mtable(object,file="",
format=c("delim","LaTeX","HTML"),\dots)
\method{toLatex}{memisc_mtable}(object,...)
}
\arguments{
\item{\dots}{as argument to \code{mtable}: several model objects, e.g. of class
\code{\link{lm}}; as argument to \code{print.memisc_mtable},
\code{toLatex.memisc_mtable}, \code{write.memisc_mtable}: further arguments
passed to \code{format.memisc_mtable}; as argument to \code{format.memisc_mtable}:
further arguments passed to \code{format.default};
as argument to \code{relabel.memisc_mtable}: further arguments
passed to \code{\link{dimrename}}.
}
\item{coef.style}{a character string which specifies the style of
coefficient values, whether standard errors, Wald/t-statistics,
or significance levels are reported, etc. See \code{\link{coef.style}}.}
\item{summary.stats}{if \code{FALSE}, no summary statistics
are repored. If \code{TRUE} then for each object in \code{\dots}
either all summary statistics are reported, or those specified by
the option \code{"summary.stats.<cls>"}, where \code{<cls>} is
the class of the respective object.
This argument may also contain a character vector with
the names of the summary statistics to report, or a list of
character vectors with names of summary statistics for each
object passed as argument in \code{\dots}.
}
\item{signif.symbols}{a named numeric vector to specify
the "significance levels" and corresponding symbols.
The numeric elements define the significance levels,
the attached names define the associated symbols.}
\item{factor.style}{a character string that specifies the style in
which factor contrasts are labled. See \code{\link{factor.style}}.}
\item{show.baselevel}{logical; determines whether base levels of factors are indicated
for dummy coefficients}
\item{baselevel.sep}{character that is used to separate the base level from the
level that a dummy variable represents}
\item{getSummary}{a function that computes model-related statistics that
appear in the table. See \code{\link{getSummary}}.}
\item{float.style}{default format for floating point numbers if
no format is specified by \code{coef.style}}.
\item{digits}{number of significant digits if not specified by
the template returned from \code{\link{getCoefTemplate}}
\code{\link{getSummaryTemplate}}
}
\item{sdigits}{integer; number of digits after decimal dot for
summary statistics.}
\item{show.eqnames}{logical; if \code{TRUE}, left-hand sides
of equations are (always) shown in the table header;
if \code{FALSE}, left-hand sides
of equations are not shown;
if \code{NA}, left-hand sides
of equations are shown only if left-hand sides differ
among models or one of the models has multiple equations.
}
\item{gs.options}{an optional list of arguments passed on to
\code{getSummary}}
\item{controls}{an optional formula or character vector that
designates "control variables" for which no coefficients are
reported, but only whether they are present in the model.
}
\item{collapse.controls}{a logical values; should the report about
inclusion of control variables collapsed to a single value? If
yes, models should either contain none or all of the control
variables.
}
\item{control.var.indicator}{
a character vector with to elements; the first element being used
to indicate the presence of a control variable or all
control variables (if \code{collapse.controls=TRUE}), the second
element being used otherwise. By default these elements are
\code{"Yes"} and \code{"No"}.
}
\item{x, object}{an object of class \code{mtable}}
\item{gsub, warn, fixed}{logical values, see \code{\link{relabel}}}
\item{target}{a character string which indicates the target format.
Currenlty the targets
"print" (see \code{\link{mtable_format_print}}),
"LaTeX" (see \code{\link{mtable_format_latex}}),
"HTML" (see \code{\link{mtable_format_html}}), and
"delim" (see \code{\link{mtable_format_delim}})
are supported.
}
\item{center.at}{a character string on which resulting values are centered.
Typically equal to ".". This is the default when \code{forLaTeX==TRUE}.
If \code{NULL}, reported values are not centered.}
\item{topsep}{a character string that is recycled to a top rule.}
\item{bottomsep}{a character string that is recycled to a bottom rule.}
\item{sectionsep}{a character string that is recycled to seperate coefficients
from summary statistics.}
\item{file}{name of the file where to write to; defaults to console output.}
\item{format}{character string that specifies the desired format.}
}
\details{
\code{mtable} constructs a table of estimates for regression-type models.
\code{format.memisc_mtable} formats suitable for use with output or conversion functions
such as \code{print.memisc_mtable}, \code{toLatex.memisc_mtable}, or
\code{write.memisc_mtable}.
}
\value{
A call to \code{mtable} results in an object of class \code{"mtable"}
with the following components:
\item{coefficients}{a list that contains the model coefficients,}
\item{summaries}{a matrix that contains the model summaries,}
\item{calls}{a list of calls that created the model estimates
being summarised.}
}
\examples{
#### Basic workflow
lm0 <- lm(sr ~ pop15 + pop75, data = LifeCycleSavings)
lm1 <- lm(sr ~ dpi + ddpi, data = LifeCycleSavings)
lm2 <- lm(sr ~ pop15 + pop75 + dpi + ddpi, data = LifeCycleSavings)
options(summary.stats.lm=c("R-squared","N"))
mtable("Model 1"=lm0,"Model 2"=lm1,"Model 3"=lm2)
options(summary.stats.lm=c("sigma","R-squared","N"))
mtable("Model 1"=lm0,"Model 2"=lm1,"Model 3"=lm2)
options(summary.stats.lm=NULL)
mtable123 <- mtable("Model 1"=lm0,"Model 2"=lm1,"Model 3"=lm2,
summary.stats=c("sigma","R-squared","F","p","N"))
(mtable123 <- relabel(mtable123,
"(Intercept)" = "Constant",
pop15 = "Percentage of population under 15",
pop75 = "Percentage of population over 75",
dpi = "Real per-capita disposable income",
ddpi = "Growth rate of real per-capita disp. income"
))
# This produces output in tab-delimited format:
write.mtable(mtable123)
\dontrun{
# This produces output in tab-delimited format:
file123 <- "mtable123.txt"
write.mtable(mtable123,file=file123)
file.show(file123)
# The contents of this file can be pasted into Word
# and converted into a Word table.
}
\dontshow{toLatex(mtable123)}
\dontrun{texfile123 <- "mtable123.tex"
write.mtable(mtable123,format="LaTeX",file=texfile123)
file.show(texfile123)}
#### Examples with UC Berkeley data
berkeley <- Aggregate(Table(Admit,Freq)~.,data=UCBAdmissions)
berk0 <- glm(cbind(Admitted,Rejected)~1,data=berkeley,family="binomial")
berk1 <- glm(cbind(Admitted,Rejected)~Gender,data=berkeley,family="binomial")
berk2 <- glm(cbind(Admitted,Rejected)~Gender+Dept,data=berkeley,family="binomial")
mtable(berk0,summary.stats=c("Deviance","N"))
mtable(berk1,summary.stats=c("Deviance","N"))
mtable(berk0,berk1,berk2,summary.stats=c("Deviance","N"))
mtable(berk0,berk1,berk2,
coef.style="horizontal",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="stat",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="ci",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="ci.se",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="ci.se.horizontal",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="ci.p.horizontal",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="ci.horizontal",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="all",
summary.stats=c("Deviance","AIC","N"))
mtable(berk0,berk1,berk2,
coef.style="all.nostar",
summary.stats=c("Deviance","AIC","N"))
mtable(by(berkeley,berkeley$Dept,
function(x)glm(cbind(Admitted,Rejected)~Gender,
data=x,family="binomial")),
summary.stats=c("Likelihood-ratio","N"))
mtable(By(~Gender,
glm(cbind(Admitted,Rejected)~Dept,
family="binomial"),
data=berkeley),
summary.stats=c("Likelihood-ratio","N"))
berkfull <- glm(cbind(Admitted,Rejected)~Dept/Gender - 1,
data=berkeley,family="binomial")
relabel(mtable(berkfull),Dept="Department",gsub=TRUE)
#### Array-like semantics
mtable123 <- mtable("Model 1"=lm0,"Model 2"=lm1,"Model 3"=lm2,
summary.stats=c("sigma","R-squared","F","p","N"))
dim(mtable123)
dimnames(mtable123)
mtable123[c("dpi","ddpi"),
c("Model 2","Model 3")]
#### Concatention
mt01 <- mtable(lm0,lm1,summary.stats=c("R-squared","N"))
mt12 <- mtable(lm1,lm2,summary.stats=c("R-squared","F","N"))
c(mt01,mt12) # not that this makes sense, but ...
c("Group 1"=mt01,
"Group 2"=mt12)
}
\keyword{misc}
|
