toLatex
Additional Methods for LaTeX Representations for R objects
Methods for the generic function toLatex
of package ``utils''
are provided for generating LaTeX representations
of matrices and flat contingency tables (see ftable
). Also a default method is defined
that coerces its first argument into a matrix and applies
the matrix method.
- Keywords
- misc
Usage
# S3 method for default
toLatex(object,…)# S3 method for matrix
toLatex(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),
…)
# S3 method for data.frame
toLatex(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),
…)
# S3 method for ftable
toLatex(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,
…)
# S3 method for ftable_matrix
toLatex(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),
…)
Arguments
- object
an
ftable
, a matrix or an object coercable into a matrix.- show.titles
logical, should variable names (in case of the
ftable
andtable
methods) or row and column names (in case of thematrix
method) be appear in theLaTeX
code?- show.vars,show.xvar,show.yvar
logical, should the names of the dimnames of
object
be shown in the margins of the LaTeX tabular? Such names usually represent the row and/or column variables of a two-dimensionaltable
.- digits
number of significant digits.
- format
character containing a format specifier, see
format
.- useDcolumn
logical, should the facilities of the
dcolumn
LaTeX package be used? Note that, if TRUE, you will need to include\usepackage{dcolumn}
in the preamble of your LaTeX document.- colspec
character, LaTeX table column format specifyer(s).
- numeric.colspec
character, LaTeX table column format specifyer(s) for numeric vectors in the data frame.
- factor.colspec
character, LaTeX table column format specifyer(s) for factors in the data frame.
- LaTeXdec
character, the decimal point in the final LaTeX output.
- ddigits
integer, digits after the decimal point.
- useBooktabs
logical, should the facilities of the
booktabs
LaTeX package be used? Note that, if TRUE, you will need to include\usepackage{booktabs}
in the preamble of your LaTeX document.- toprule
character string, TeX code that determines the appearance of the top border of the LaTeX
tabular
environment.- midrule
character string, TeX code that determines how coefficients and summary statistics are separated in the LaTeX
tabular
environment.- cmidrule
character string, TeX code that determines the appearance of rules under section headings.
- bottomrule
character string, TeX code that determines the appearance of the bottom border of the LaTeX
tabular
environment.- extrarowsep
character string, extra code to be inserted between the column titles and the table body produced by
toLatex
.- compact
logical, if
TRUE
, extra column space between sub-tables is suppressed. Defaults toFALSE
- varontop
logical, whether names of column variables should appear on top of factor levels
- varinfront
logical, whether names of row variables should appear in front of factor levels
- groupsep
character string, containing a TeX length; extra vertical space inserted between sub-tables, unless
compact
isTRUE
.- grouprule
character string, TeX code that determines how sub-table headings are embellished.
- row.names
logical, whether row names should be included in exported LaTeX code.
- NAas
character string, how missing values should be represented.
- toLatex.escape.tex
logical, should symbols \$, \_, and \^ be escaped with backslashes?
- fold.leaders
logical, if
TRUE
, factor levels of row variables are not distributed into different columns, but 'folded' into a single column.- …
further argument, currently ignored.
Examples
# NOT RUN {
toLatex(diag(5))
toLatex(ftable(UCBAdmissions))
toLatex(rbind(
ftable(margin.table(UCBAdmissions,c(2,1))),
ftable(margin.table(UCBAdmissions,c(3,1)))
))
# }