print.xtable {xtable} | R Documentation |
Function returning and displaying or writing to disk the LaTeX or HTML code associated with the supplied object of class xtable
.
## S3 method for class 'xtable' print(x, type="latex", file="", append=FALSE, floating=TRUE, floating.environment="table", table.placement = "ht", caption.placement="bottom", latex.environments=c("center"),tabular.environment = "tabular", size=NULL, hline.after=c(-1,0,nrow(x)), NA.string = "", include.rownames=TRUE, include.colnames=TRUE, only.contents=FALSE, add.to.row=NULL, sanitize.text.function=NULL, sanitize.rownames.function=sanitize.text.function, sanitize.colnames.function=sanitize.text.function, math.style.negative=FALSE, html.table.attributes="border=1", ...)
x |
An object of class |
type |
Type of table to produce. Possible values for |
file |
Name of file where the resulting code should be saved. If |
append |
If |
floating |
If |
floating.environment |
If |
table.placement |
If |
caption.placement |
The caption will be have placed at the bottom of the table if |
latex.environments |
If |
tabular.environment |
When |
size |
An arbitrary character vector intended to be used to set the font size in a LaTeX table. The supplied value (if not |
hline.after |
When |
NA.string |
String to be used for missing values in table entries. Default value is |
include.rownames |
logical. If |
include.colnames |
logical. If |
only.contents |
logical. If |
add.to.row |
a list of two components. The first component (which should be called 'pos') is a list contains the position of rows on which extra commands should be added at the end, The second component (which should be called 'command') is a character vector of the same length of the first component which contains the command that should be added at the end of the specified rows. Default value is |
sanitize.text.function |
All non-numeric enteries (except row and column names) are sanitised in an attempt to remove characters which have special meaning for the output format. If |
sanitize.rownames.function |
Like the |
sanitize.colnames.function |
Like the |
math.style.negative |
In a LaTeX table, if |
html.table.attributes |
In an HTML table, attributes associated with the |
... |
Additional arguments. (Currently ignored.) |
This function displays or writes to disk the code to produce a table associated with an object x
of class "xtable"
.
The resulting code is either a LaTeX or HTML table, depending on the value of type
. The function also (invisibly) returns a character vector
of the results (which can be helpful for post-processing).
Since version 1.4 the non default behavior of hline.after
is changed. To obtain the same results as the previous versions add to the hline.after
vector the vector c(-1, 0, nrow(x))
where nrow(x)
is the numbers of rows of the object.
From version 1.4-3, all non-numeric columns are sanitized, and all LaTeX special characters are sanitised for LaTeX output. See Section 3 of the xtableGallery
vignette for an example of customising the sanitization.
From version 1.4-4, the sanitization also applies to column names. To remove any text sanitization, specify sanitize.text.function=function(x){x}
.
David Dahl dahl@stat.tamu.edu with contributions and suggestions from many others (see source code).
Fairbairns, Robin (2005) Tables longer than a single page The UK List of TeX Frequently Asked Questions on the Web. http://www.tex.ac.uk/cgi-bin/texfaq2html?label=longtab
xtable
, caption
, label
,
align
, digits
, display
, formatC