3 \title{Print Export Tables}
\r
4 \description{Function returning and displaying or writing to disk the LaTeX or HTML code associated with the supplied object of class \code{xtable}.}
\r
6 \method{print}{xtable}(x,
\r
7 type=getOption("xtable.type", "latex"),
\r
8 file=getOption("xtable.file", ""),
\r
9 append=getOption("xtable.append", FALSE),
\r
10 floating=getOption("xtable.floating", TRUE),
\r
11 floating.environment=getOption("xtable.floating.environment", "table"),
\r
12 table.placement=getOption("xtable.table.placement", "ht"),
\r
13 caption.placement=getOption("xtable.caption.placement", "bottom"),
\r
14 latex.environments=getOption("xtable.latex.environments", c("center")),
\r
15 tabular.environment=getOption("xtable.tabular.environment", "tabular"),
\r
16 size=getOption("xtable.size", NULL),
\r
17 hline.after=getOption("xtable.hline.after", c(-1,0,nrow(x))),
\r
18 NA.string=getOption("xtable.NA.string", ""),
\r
19 include.rownames=getOption("xtable.include.rownames", TRUE),
\r
20 include.colnames=getOption("xtable.include.colnames", TRUE),
\r
21 only.contents=getOption("xtable.only.contents", FALSE),
\r
22 add.to.row=getOption("xtable.add.to.row", NULL),
\r
23 sanitize.text.function=getOption("xtable.sanitize.text.function", NULL),
\r
24 sanitize.rownames.function=getOption("xtable.sanitize.rownames.function",
\r
25 sanitize.text.function),
\r
26 sanitize.colnames.function=getOption("xtable.sanitize.colnames.function",
\r
27 sanitize.text.function),
\r
28 math.style.negative=getOption("xtable.math.style.negative", FALSE),
\r
29 html.table.attributes=getOption("xtable.html.table.attributes", "border=1"),
\r
30 print.results=getOption("xtable.print.results", TRUE),
\r
31 format.args=getOption("xtable.format.args", NULL),
\r
32 rotate.rownames=getOption("xtable.rotate.rownames", FALSE),
\r
33 rotate.colnames=getOption("xtable.rotate.colnames", FALSE),
\r
34 booktabs = getOption("xtable.booktabs", FALSE),
\r
35 scalebox = getOption("xtable.scalebox", NULL),
\r
38 \item{x}{An object of class \code{"xtable"}.}
\r
39 \item{type}{Type of table to produce. Possible values for \code{type} are \code{"latex"} or \code{"html"}.
\r
40 Default value is \code{"latex"}.}
\r
41 \item{file}{Name of file where the resulting code should be saved. If \code{file=""}, output is displayed on screen. Note that
\r
42 the function also (invisibly) returns a character vector of the results (which can be helpful for post-processing).
\r
43 Default value is \code{""}.}
\r
44 \item{append}{If \code{TRUE} and \code{file!=""}, code will be appended to \code{file} instead of overwriting \code{file}.
\r
45 Default value is \code{FALSE}.}
\r
46 \item{floating}{If \code{TRUE} and \code{type="latex"}, the resulting table will be a floating table (using, for example, \code{\\begin\{table\}} and \code{\\end\{table\}}). See \code{floating.environment} below. Default value is \code{TRUE}.}
\r
47 \item{floating.environment}{If \code{floating=TRUE} and \code{type="latex"}, the resulting table uses the specified floating environment.
\r
48 Possible values are \code{"table"}, \code{"table*"}, or \code{"sidewaystable"} (defined in the LaTeX package 'rotating').
\r
49 Default value is \code{"table"}.}
\r
50 \item{table.placement}{If \code{floating=TRUE} and \code{type="latex"}, the floating table will have placement given by \code{table.placement} where \code{table.placement} must be \code{NULL} or contain only elements of \{"h","t","b","p","!","H"\}.
\r
51 Default value is \code{"ht"}.}
\r
52 \item{caption.placement}{The caption will be have placed at the bottom of the table if \code{caption.placement} is \code{"bottom"} and at the top of the table if it equals \code{"top"}.
\r
53 Default value is \code{"bottom"}.}
\r
54 \item{latex.environments}{If \code{floating=TRUE} and \code{type="latex"}, the specificed latex environments (provided as a character vector) will enclose the tabuluar environment.
\r
55 Default value is \code{"center"}.}
\r
56 \item{tabular.environment}{When \code{type="latex"}, the tabular environment that will be used. Defaults to \code{"tabular"}. When working with tables that extend more than one page, using \code{tabular.environment="longtable"} and the LaTeX package \code{"longtable"} (see Fairbairns, 2005) allows one to typeset them uniformly. Note that \code{"floating"} should be set to \code{"FALSE"} when using the \code{"longtable"} environment.}
\r
57 \item{size}{An arbitrary character vector intended to be used to set the font size in a LaTeX table. The supplied value (if not \code{NULL}) is inserted just before the tabular environment starts. Default value is \code{NULL}.}
\r
58 \item{hline.after}{When \code{type="latex"}, a vector of numbers between -1 and \code{"nrow(x)"}, inclusive, indicating the rows after which a horizontal line should appear. If \code{NULL} is used no lines are produced. Default value is \code{c(-1,0,nrow(x))} which means draw a line before and after the columns names and at the end of the table. Repeated values are allowed.}
\r
59 \item{NA.string}{String to be used for missing values in table entries. Default value is \code{""}.}
\r
60 \item{include.rownames}{logical. If \code{TRUE} the rows names is printed. Default value is \code{TRUE}.}
\r
61 \item{include.colnames}{logical. If \code{TRUE} the columns names is printed. Default value is \code{TRUE}.}
\r
62 \item{only.contents}{logical. If \code{TRUE} only the rows of the table is printed. Default value is \code{FALSE}.}
\r
63 \item{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 \code{NULL}, i.e. do not add commands.}
\r
64 \item{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 \code{sanitize.text.function} is not NULL (the default), it should be a function taking a character vector and returning one, and will be used for the sanitization instead of the default internal function.}
\r
65 \item{sanitize.rownames.function}{Like the \code{sanitize.text.function}, but applicable to row names. The default uses the \code{sanitize.text.function}.}
\r
66 \item{sanitize.colnames.function}{Like the \code{sanitize.text.function}, but applicable to column names. The default uses the \code{sanitize.text.function}.}
\r
67 \item{math.style.negative}{In a LaTeX table, if \code{TRUE}, then use $-$ for the negative sign (as was the behavior prior to version 1.5-3). Default value is \code{FALSE}.}
\r
68 \item{html.table.attributes}{In an HTML table, attributes associated with the \code{<TABLE>} tag. Default value is \code{border=1}.}
\r
69 \item{print.results}{If \code{TRUE}, the generated table is printed to standard output. Set this to \code{FALSE} if you will just be using the character vector that is returned invisibly.}
\r
70 \item{format.args}{List of arguments for the \code{formatC} function. For example, standard German number separators can be specified as \code{format.args=list(big.mark = "'", decimal.mark = ","))}.}
\r
71 \item{rotate.rownames}{If \code{TRUE}, the row names are displayed vertically in LaTeX.}
\r
72 \item{rotate.colnames}{If \code{TRUE}, the column names are displayed vertically in LaTeX.}
\r
73 \item{booktabs}{If \code{TRUE}, the \code{toprule}, \code{midrule} and \code{bottomrule} tags from the LaTex "booktabs" package are used rather than \code{hline} for the horizontal line tags.}
\r
74 \item{scalebox}{If not \code{NULL}, a \code{scalebox} clause will be added around the tabular environment with the specified value used as the scaling factor.}
\r
75 \item{...}{Additional arguments. (Currently ignored.)}
\r
78 This function displays or writes to disk the code to produce a table associated with an object \code{x} of class \code{"xtable"}.
\r
79 The resulting code is either a LaTeX or HTML table, depending on the value of \code{type}. The function also (invisibly) returns a character vector
\r
80 of the results (which can be helpful for post-processing).
\r
82 Since version 1.4 the non default behavior of \code{hline.after} is changed. To obtain the same results as the previous versions add to the \code{hline.after} vector the vector \code{c(-1, 0, nrow(x))} where \code{nrow(x)} is the numbers of rows of the object.
\r
84 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 \code{xtableGallery} vignette for an example of customising the sanitization.
\r
85 From version 1.4-4, the sanitization also applies to column names. To remove any text sanitization, specify \code{sanitize.text.function=function(x){x}}.
\r
87 From version 1.6-1 the default values for the arguments other than \code{x} are obtainined using \code{getOption()}. Hence the user can set the values once with \code{options()} rather than setting them in every call to \code{print.xtable()}.
\r
89 \author{David Dahl \email{dahl@stat.tamu.edu} with contributions and suggestions from many others (see source code).}
\r
91 Fairbairns, Robin (2005) \emph{Tables longer than a single page} The UK List of TeX Frequently Asked Questions on the Web. \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=longtab}
\r
93 \seealso{\code{\link{xtable}}, \code{\link{caption}}, \code{\link{label}},
\r
94 \code{\link{align}}, \code{\link{digits}}, \code{\link{display}}, \code{\link{formatC}}}
\r
projects / xtable.git / blob