Set or query options for the table formatting.
These functions set or query options for table formatting in LaTeX or HTML output.
table_options(...) booktabs(...) htmloptions(head=TRUE, table=TRUE, pad=FALSE, ...)
head |
logical; enables all of the HTML header options |
table |
logical; enables output of all parts of the table itself |
pad |
logical; enables all of the HTML padding options |
... |
Any of the options listed in the Details below. |
The table_options()
function sets a number of options that control formatting. Currently the
options that affect both LaTeX and HTML output are:
justification = "c"
Default justification for the data columns in the table.
rowlabeljustification = "l"
Default justification for row labels.
doBegin, doHeader, doBody, doFooter, doEnd
These logical values (all defaults are TRUE
) control the inclusion of specific parts of
the output table.
knit_print = TRUE
Do auto formatting when printing in a knitr document.
These options are only used for LaTeX output:
tabular = "tabular"
The LaTeX environment to use for the table. Other choices such as "longtable"
might
make sense.
toprule, midrule, bottomrule
The LaTeX macros to use for the lines in the table. By default they are all "\hline"
.
titlerule = NULL
The LaTeX macro to use to underline multicolumn titles. If NULL
, no underlining
is done.
latexleftpad, latexrightpad, latexminus, mathmode
These control formatting of numbers in the table. If TRUE
(the default), blanks
in R's formatting are converted to hard spaces in the LaTeX output, and negative
signs are rendered properly. Generally this makes output look better, but
the ‘.tex’ input may be harder to read.
These options are only used for HTML output:
doHTMLheader, doCSS, doHTMLbody
These control output of the material at the top of an HTML page.
HTMLhead, CSS, HTMLbody
These are the default strings to output when the corresponding element is selected.
If present, the string "CHARSET"
will be replaced with the result of
localeToCharset()
in the HTMLhead
. The string
"#ID"
will be replaced with "#"
followed by the id
argument to html.tabular
(or removed if that is blank).
HTMLcaption
This is an optional HTML caption for the table. If NULL
, no
caption is emitted.
HTMLleftpad, HTMLrightpad, HTMLminus
These control formatting of numbers in the table. If TRUE
, blanks
in R's formatting are converted to hard spaces in the HTML output, and negative
signs are rendered properly. Generally this makes output look better, but
cut and paste from the table may include these special characters
and not be recognized by other software. The default is FALSE
.
HTMLattributes
This is a string to add to the "<table>"
declaration at the top of the table. By
default, the attributes are 'frame="hsides" rules="groups"'
.
These set horizontal rules on the top and bottom of the table and between the header,
body, and footer (if present).
HTMLfooter
This is NULL
for no footer, or HTML code to insert in the table. Note
that in HTML the footer should be specified before the body of the table;
html.tabular
will do this if both are written in the same call.
These may be set persistently by calling table_options()
, or just for the duration
of the call by passing them in a list via latex(options=list( ... ))
. Additional
...
arguments to latex
are passed to format
.
The booktabs()
function sets the table_options()
values to different defaults,
suitable for use with the booktabs LaTeX package.
The htmloptions()
function constructs a list suitable for the options
argument to html.tabular
, with grouping of options that
rarely differ from each other.
Note that any LaTeX code can be used in the rule options; for example, see
the longtable
example in the vignette. Material to go above the headers
goes into toprule
, material between the headers and the body goes into midrule
,
and material at the bottom of the table goes into bottomrule
.
table_options()
and booktabs()
return the previous settings.
htmloptions()
returns a list of settings without changing the defaults.
tab <- tabular( (Species + 1) ~ (n=1) + Format(digits=2)* (Sepal.Length + Sepal.Width)*(mean + sd), data=iris ) toLatex(tab) save <- booktabs() toLatex(tab) table_options(save) f <- tempfile(fileext = ".html") toHTML(tab, f, options=htmloptions(HTMLcaption="Table of Iris Data", pad = TRUE))
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.