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
|
\name{toLatex}
\alias{toLatex.default}
\alias{toLatex.ftable}
\alias{toLatex.matrix}
\alias{toLatex.data.frame}
\alias{toLatex.ftable_matrix}
\title{Additional Methods for LaTeX Representations for R objects}
\description{
Methods for the generic function \code{\link[utils]{toLatex}} of package ``\link{utils}''
are provided for generating LaTeX representations
of matrices and flat contingency tables (see \code{\link{ftable}}). Also a default method is defined
that coerces its first argument into a matrix and applies
the matrix method.
}
\usage{
\method{toLatex}{default}(object,\dots)
\method{toLatex}{matrix}(object,
show.titles=TRUE,
show.vars=FALSE,
show.xvar=show.vars,
show.yvar=show.vars,
digits=if(is.table(object)) 0 else getOption("digits"),
format="f",
useDcolumn=getOption("useDcolumn",TRUE),
colspec=if(useDcolumn)
paste("D{.}{",LaTeXdec,"}{",ddigits,"}",sep="")
else "r",
LaTeXdec=".",
ddigits=digits,
useBooktabs=getOption("useBooktabs",TRUE),
toprule=if(useBooktabs) "\\\\toprule" else "\\\\hline\\\\hline",
midrule=if(useBooktabs) "\\\\midrule" else "\\\\hline",
cmidrule=if(useBooktabs) "\\\\cmidrule" else "\\\\cline",
bottomrule=if(useBooktabs) "\\\\bottomrule" else "\\\\hline\\\\hline",
toLatex.escape.tex=getOption("toLatex.escape.tex",FALSE),
\dots)
\method{toLatex}{data.frame}(object,
digits=getOption("digits"),
format="f",
useDcolumn=getOption("useDcolumn",TRUE),
numeric.colspec=if(useDcolumn)
paste("D{.}{",LaTeXdec,"}{",ddigits,"}",sep="")
else "r",
factor.colspec="l",
LaTeXdec=".",
ddigits=digits,
useBooktabs=getOption("useBooktabs",TRUE),
toprule=if(useBooktabs) "\\\\toprule" else "\\\\hline\\\\hline",
midrule=if(useBooktabs) "\\\\midrule" else "\\\\hline",
cmidrule=if(useBooktabs) "\\\\cmidrule" else "\\\\cline",
bottomrule=if(useBooktabs) "\\\\bottomrule" else "\\\\hline\\\\hline",
row.names=is.character(attr(object,"row.names")),
NAas="",
toLatex.escape.tex=getOption("toLatex.escape.tex",FALSE),
\dots)
\method{toLatex}{ftable}(object,
show.titles=TRUE,
digits=if(is.integer(object)) 0 else getOption("digits"),
format=if(is.integer(object)) "d" else "f",
useDcolumn=getOption("useDcolumn",TRUE),
colspec=if(useDcolumn)
paste("D{.}{",LaTeXdec,"}{",ddigits,"}",sep="")
else "r",
LaTeXdec=".",
ddigits=digits,
useBooktabs=getOption("useBooktabs",TRUE),
toprule=if(useBooktabs) "\\\\toprule" else "\\\\hline\\\\hline",
midrule=if(useBooktabs) "\\\\midrule" else "\\\\hline\n",
cmidrule=if(useBooktabs) "\\\\cmidrule" else "\\\\cline",
bottomrule=if(useBooktabs) "\\\\bottomrule" else "\\\\hline\\\\hline",
extrarowsep = NULL,
toLatex.escape.tex=getOption("toLatex.escape.tex",FALSE),
fold.leaders=FALSE,
\dots)
\method{toLatex}{ftable_matrix}(object,
show.titles=TRUE,
digits=getOption("digits"),
format="f",
useDcolumn=getOption("useDcolumn",TRUE),
colspec=if(useDcolumn)
paste("D{.}{",LaTeXdec,"}{",ddigits,"}",sep="")
else "r",
LaTeXdec=".",
ddigits=digits,
useBooktabs=getOption("useBooktabs",TRUE),
toprule=if(useBooktabs) "\\\\toprule" else "\\\\hline\\\\hline",
midrule=if(useBooktabs) "\\\\midrule" else "\\\\hline",
cmidrule=if(useBooktabs) "\\\\cmidrule" else "\\\\cline",
bottomrule=if(useBooktabs) "\\\\bottomrule" else "\\\\hline\\\\hline",
compact=FALSE,
varontop,varinfront,
groupsep="3pt",
grouprule=midrule,
toLatex.escape.tex=getOption("toLatex.escape.tex",FALSE),
multi_digits=NULL,
\dots)
}
\arguments{
\item{object}{an \code{\link{ftable}}, a matrix or an object coercable into
a matrix. }
\item{show.titles}{logical, should variable names (in case of the
\code{ftable} and \code{table} methods)
or row and column names (in case of the \code{matrix} method) be appear
in the \code{LaTeX} code? }
\item{show.vars,show.xvar,show.yvar}{logical, should the names of the dimnames of \code{object}
be shown in the margins of the LaTeX tabular? Such names usually represent the
row and/or column variables of a two-dimensional \code{\link{table}}.
}
\item{digits}{number of significant digits.
}
\item{format}{character containing a format specifier, see \code{\link{format}}. }
\item{useDcolumn}{logical, should the facilities of the \code{dcolumn} LaTeX package be used?
Note that, if TRUE, you will need to include \code{\\usepackage{dcolumn}}
in the preamble of your LaTeX document.}
\item{colspec}{character, LaTeX table column format specifyer(s).}
\item{numeric.colspec}{character, LaTeX table column format
specifyer(s) for numeric vectors in the data frame.}
\item{factor.colspec}{character, LaTeX table column format
specifyer(s) for factors in the data frame.}
\item{LaTeXdec}{character, the decimal point in the final LaTeX output.}
\item{ddigits}{integer, digits after the decimal point.}
\item{useBooktabs}{logical, should the facilities of the \code{booktabs} LaTeX package be used?
Note that, if TRUE, you will need to include \code{\\usepackage{booktabs}}
in the preamble of your LaTeX document.}
\item{toprule}{character string, TeX code that determines the appearance of the top border of the LaTeX \code{tabular} environment.}
\item{midrule}{character string, TeX code that determines how coefficients and summary statistics are
separated in the LaTeX \code{tabular} environment.}
\item{cmidrule}{character string, TeX code that determines the appearance of rules under section headings.}
\item{bottomrule}{character string, TeX code that determines the appearance of the bottom border of the LaTeX \code{tabular} environment.}
\item{extrarowsep}{character string, extra code to be inserted between the column titles and the
table body produced by \code{toLatex}. }
\item{compact}{logical, if \code{TRUE}, extra column space between sub-tables
is suppressed. Defaults to \code{FALSE}}
\item{varontop}{logical, whether names of column variables should appear on top of factor levels}
\item{varinfront}{logical, whether names of row variables should appear in front of factor levels}
\item{groupsep}{character string, containing a TeX length; extra
vertical space inserted between sub-tables, unless \code{compact} is \code{TRUE}.}
\item{grouprule}{character string, TeX code that determines how
sub-table headings are embellished.}
\item{row.names}{logical, whether row names should be included in
exported LaTeX code.}
\item{NAas}{character string, how missing values should be represented.}
\item{toLatex.escape.tex}{logical, should symbols "$", "_", and "^" be
escaped with backslashes?}
\item{fold.leaders}{logical, if \code{TRUE}, factor levels of row
variables are not distributed into different columns, but
'folded' into a single column.}
\item{multi_digits}{NULL, a numeric vector, or a list. If it is a
list it should have as many elements as
the "ftable_matrix" contains columns, where each vector has
as many columns as the respective "ftable". If it is a
vector, it is put into a list with replicated elements
according to the "ftable" components.
The elements of these vectors can be used to specify a separate
number of digits for each column of the respective "ftable".}
\item{\dots}{further argument, currently ignored.}
}
\examples{
toLatex(diag(5))
toLatex(ftable(UCBAdmissions))
toLatex(rbind(
ftable(margin.table(UCBAdmissions,c(2,1))),
ftable(margin.table(UCBAdmissions,c(3,1)))
))
}
\keyword{misc}
|
