Description Usage Arguments Details Author(s) References See Also Examples
Function returning and displaying or writing to disk the LaTeX or HTML
code associated with the supplied object of class xtable
.
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 | ## S3 method for class 'xtable'
print(x,
type = getOption("xtable.type", "latex"),
file = getOption("xtable.file", ""),
append = getOption("xtable.append", FALSE),
floating = getOption("xtable.floating", TRUE),
floating.environment = getOption("xtable.floating.environment", "table"),
table.placement = getOption("xtable.table.placement", "ht"),
caption.placement = getOption("xtable.caption.placement", "bottom"),
caption.width = getOption("xtable.caption.width", NULL),
latex.environments = getOption("xtable.latex.environments", c("center")),
tabular.environment = getOption("xtable.tabular.environment", "tabular"),
size = getOption("xtable.size", NULL),
hline.after = getOption("xtable.hline.after", c(-1,0,nrow(x))),
NA.string = getOption("xtable.NA.string", ""),
include.rownames = getOption("xtable.include.rownames", TRUE),
include.colnames = getOption("xtable.include.colnames", TRUE),
only.contents = getOption("xtable.only.contents", FALSE),
add.to.row = getOption("xtable.add.to.row", NULL),
sanitize.text.function = getOption("xtable.sanitize.text.function", NULL),
sanitize.rownames.function = getOption("xtable.sanitize.rownames.function",
sanitize.text.function),
sanitize.colnames.function = getOption("xtable.sanitize.colnames.function",
sanitize.text.function),
math.style.negative = getOption("xtable.math.style.negative", FALSE),
math.style.exponents = getOption("xtable.math.style.exponents", FALSE),
html.table.attributes = getOption("xtable.html.table.attributes",
"border=1"),
print.results = getOption("xtable.print.results", TRUE),
format.args = getOption("xtable.format.args", NULL),
rotate.rownames = getOption("xtable.rotate.rownames", FALSE),
rotate.colnames = getOption("xtable.rotate.colnames", FALSE),
booktabs = getOption("xtable.booktabs", FALSE),
scalebox = getOption("xtable.scalebox", NULL),
width = getOption("xtable.width", NULL),
comment = getOption("xtable.comment", TRUE),
timestamp = getOption("xtable.timestamp", date()),
...)
|
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 placed at the bottom
of the table if |
caption.width |
The caption will be placed in a |
latex.environments |
If |
tabular.environment |
When |
size |
A character vector that is inserted just before the
tabular environment starts. This can be used to set the font size
and a variety of other table settings. Initial backslashes are
automatically prefixed, if not supplied by user.
Default value is |
hline.after |
When |
NA.string |
String to be used for missing values in table
entries.
Default value is |
include.rownames |
If |
include.colnames |
If |
only.contents |
If |
add.to.row |
A list of two components. The first component (which
should be called 'pos') is a list that 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 as 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 entries (except row and
column names) are sanitized 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 |
math.style.exponents |
In a LaTeX table, if |
html.table.attributes |
In an HTML table, attributes associated
with the |
print.results |
If |
format.args |
List of arguments for the |
rotate.rownames |
If |
rotate.colnames |
If |
booktabs |
If |
scalebox |
If not |
width |
If not |
comment |
If |
timestamp |
Timestamp to include in LaTeX comment. Set this
to |
... |
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 sanitized for LaTeX output. See Section
3 of the xtableGallery
vignette for an example of customizing
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}
.
From version 1.6-1 the default values for the arguments other than
x
are obtained using getOption()
. Hence the user can
set the values once with options()
rather than setting them in
every call to print.xtable()
.
The argument format.args
is used to supply arguments to the
formatC
function, but will throw an error if values for
digits
or format
are included in the list of
arguments. The recommended approach to specify digits
is to supply
the argument digits
to xtable
, and to specify
format
supply the argument display
to xtable
. See
the examples.
David Dahl dahl@stat.byu.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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | df <- data.frame(A = c(1.00123, 33.1, 6),
B = c(111111, 3333333, 3123.233))
## The following code gives the error
## formal argument "digits" matched by multiple actual arguments
## print(xtable(df, display = c("s","e","e")),
## format.args = list(digits = 3, big.mark = " ", decimal.mark = ","))
## specify digits as argument to xtable instead
print(xtable(df, display = c("s","f","f"), digits = 4),
format.args = list(big.mark = " ", decimal.mark = ","))
## The following code gives the error
## formal argument "format" matched by multiple actual arguments
## print(xtable(df, digits = 4),
## format.args = list(format = c("s","e","e"),
## big.mark = " ", decimal.mark = ","))
## specify format using display argument in xtable
print(xtable(df, display = c("s","e","e"), digits = 4),
format.args = list(big.mark = " ", decimal.mark = ","))
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.