code associated with the supplied object of class \code{xtable}.\r
}\r
\usage{\r
-\method{print}{xtable}(x, \r
+\method{print}{xtable}(x,\r
type = getOption("xtable.type", "latex"),\r
file = getOption("xtable.file", ""),\r
append = getOption("xtable.append", FALSE),\r
only.contents = getOption("xtable.only.contents", FALSE),\r
add.to.row = getOption("xtable.add.to.row", NULL),\r
sanitize.text.function = getOption("xtable.sanitize.text.function", NULL),\r
- sanitize.rownames.function = getOption("xtable.sanitize.rownames.function", \r
+ sanitize.rownames.function = getOption("xtable.sanitize.rownames.function",\r
sanitize.text.function),\r
- sanitize.colnames.function = getOption("xtable.sanitize.colnames.function", \r
+ sanitize.colnames.function = getOption("xtable.sanitize.colnames.function",\r
sanitize.text.function),\r
math.style.negative = getOption("xtable.math.style.negative", FALSE),\r
+ math.style.exponents = getOption("xtable.math.style.exponents", FALSE),\r
html.table.attributes = getOption("xtable.html.table.attributes",\r
"border=1"),\r
print.results = getOption("xtable.print.results", TRUE),\r
...)}\r
\arguments{\r
\item{x}{An object of class \code{"xtable"}.}\r
- \item{type}{Type of table to produce. Possible values for \code{type}\r
+ \item{type}{Type of table to produce. Possible values for \code{type}\r
are \code{"latex"} or \code{"html"}.\r
Default value is \code{"latex"}.}\r
\item{file}{Name of file where the resulting code should be saved. If\r
Default value is \code{TRUE}. }\r
\item{floating.environment}{If \code{floating=TRUE} and\r
\code{type="latex"}, the resulting table uses the specified floating\r
- environment. Possible values include \code{"table"}, \code{"table*"}, \r
+ environment. Possible values include \code{"table"}, \code{"table*"},\r
and other floating environments defined in LaTeX packages.\r
Default value is \code{"table"}.}\r
\item{table.placement}{If \code{floating=TRUE} and\r
\code{NULL} or contain only elements of\r
\{"h","t","b","p","!","H"\}.\r
Default value is \code{"ht"}.}\r
- \item{caption.placement}{The caption will be have placed at the bottom\r
+ \item{caption.placement}{The caption will be placed at the bottom\r
of the table if \code{caption.placement} is \code{"bottom"} and at\r
the top of the table if it equals \code{"top"}.\r
Default value is \code{"bottom"}.}\r
of the specified width if \code{caption.width} is not \code{NULL} and\r
\code{type="latex"}. Default value is \code{NULL}.}\r
\item{latex.environments}{If \code{floating=TRUE} and\r
- \code{type="latex"}, the specificed latex environments (provided as\r
+ \code{type="latex"}, the specified LaTeX environments (provided as\r
a character vector) will enclose the tabular environment.\r
Default value is \code{"center"}. }\r
\item{tabular.environment}{When \code{type="latex"}, the tabular\r
environment that will be used.\r
- Defaults to \code{"tabular"}.\r
When working with tables that extend more than one page, using\r
- \code{tabular.environment="longtable"} and the LaTeX package\r
- \code{"longtable"} (see Fairbairns, 2005) allows one to typeset them\r
- uniformly. Note that \code{"floating"} should be set to\r
- \code{"FALSE"} when using the \code{"longtable"} environment.}\r
- \item{size}{An arbitrary character vector intended to be used to set\r
- the font size in a LaTeX table. The supplied value (if not\r
- \code{NULL}) is inserted just before the tabular environment\r
- starts.\r
+ \code{tabular.environment="longtable"} with the corresponding\r
+ LaTeX package (see Fairbairns, 2005) allows one to typeset them\r
+ uniformly. Note that \code{floating} should be set to\r
+ \code{FALSE} when using the \code{longtable} environment.\r
+ Default value is \code{"tabular"}.}\r
+ \item{size}{A character vector that is inserted just before the\r
+ tabular environment starts. This can be used to set the font size\r
+ and a variety of other table settings. Initial backslashes are\r
+ automatically prefixed, if not supplied by user.\r
Default value is \code{NULL}. }\r
\item{hline.after}{When \code{type="latex"}, a vector of numbers\r
- between -1 and \code{"nrow(x)"}, inclusive, indicating the rows\r
+ between -1 and \code{nrow(x)}, inclusive, indicating the rows\r
after which a horizontal line should appear. If \code{NULL} is used\r
- no lines are produced.\r
+ no lines are produced. Repeated values are allowed.\r
Default value is \code{c(-1,0,nrow(x))} which means draw a line\r
before and after the columns names and at the end of the\r
- table. Repeated values are allowed.}\r
+ table.}\r
\item{NA.string}{String to be used for missing values in table\r
entries.\r
Default value is \code{""}.}\r
- \item{include.rownames}{logical. If \code{TRUE} the rows names is\r
+ \item{include.rownames}{If \code{TRUE} the rows names are\r
printed.\r
Default value is \code{TRUE}.}\r
- \item{include.colnames}{logical. If \code{TRUE} the columns names is\r
+ \item{include.colnames}{If \code{TRUE} the columns names are\r
printed.\r
Default value is \code{TRUE}.}\r
- \item{only.contents}{logical. If \code{TRUE} only the rows of the\r
- table is printed.\r
+ \item{only.contents}{If \code{TRUE} only the rows of the\r
+ table are printed.\r
Default value is \code{FALSE}. }\r
- \item{add.to.row}{a list of two components. The first component (which\r
- should be called 'pos') is a list contains the position of rows on\r
- which extra commands should be added at the end, The second\r
+ \item{add.to.row}{A list of two components. The first component (which\r
+ should be called 'pos') is a list that contains the position of rows on\r
+ which extra commands should be added at the end. The second\r
component (which should be called 'command') is a character vector\r
- of the same length of the first component which contains the command\r
+ of the same length as the first component, which contains the command\r
that should be added at the end of the specified rows.\r
Default value is \code{NULL}, i.e. do not add commands.}\r
- \item{sanitize.text.function}{All non-numeric enteries (except row and\r
- column names) are sanitised in an attempt to remove characters which\r
+ \item{sanitize.text.function}{All non-numeric entries (except row and\r
+ column names) are sanitized in an attempt to remove characters which\r
have special meaning for the output format. If\r
- \code{sanitize.text.function} is not NULL (the default), it should\r
+ \code{sanitize.text.function} is not \code{NULL}, it should\r
be a function taking a character vector and returning one, and will\r
be used for the sanitization instead of the default internal\r
- function.}\r
+ function.\r
+ Default value is \code{NULL}.}\r
\item{sanitize.rownames.function}{Like the\r
\code{sanitize.text.function}, but applicable to row names.\r
The default uses the \code{sanitize.text.function}. }\r
The default uses the \code{sanitize.text.function}. }\r
\item{math.style.negative}{In a LaTeX table, if \code{TRUE}, then use\r
$-$ for the negative sign (as was the behavior prior to version 1.5-3).\r
+ Default value is \code{FALSE}.} \r
+ \item{math.style.exponents}{In a LaTeX table, if \code{TRUE} or\r
+ \code{"$$"}, then use \verb{$5 \times 10^{5}$} for 5e5. If\r
+ \code{"ensuremath"}, then use \verb{\\ensuremath{5 \times 10^{5}}}\r
+ for 5e5. If \code{"UTF-8"} or \code{"UTF-8"}, then use UTF-8 to\r
+ approximate the LaTeX typsetting for 5e5.\r
Default value is \code{FALSE}.}\r
\item{html.table.attributes}{In an HTML table, attributes associated\r
- with the \code{<TABLE>}tag.\r
- Default value is \code{border=1}.}\r
+ with the \code{<TABLE>} tag.\r
+ Default value is \code{"border=1"}.}\r
\item{print.results}{If \code{TRUE}, the generated table is printed to\r
standard output. Set this to \code{FALSE} if you will just be using\r
- the character vector that is returned invisibly.}\r
+ the character vector that is returned invisibly.\r
+ Default value is \code{TRUE}.}\r
\item{format.args}{List of arguments for the \code{formatC} function.\r
For example, standard German number separators can be specified as\r
- \code{format.args=list(big.mark = "'", decimal.mark = ","))}. }\r
+ \code{format.args=list(big.mark = "'", decimal.mark =\r
+ ","))}. The arguments \code{digits} and \code{format} should not be\r
+ included in this list. See details.\r
+ Default value is \code{NULL}.}\r
\item{rotate.rownames}{If \code{TRUE}, the row names are displayed\r
- vertically in LaTeX. }\r
+ vertically in LaTeX.\r
+ Default value is \code{FALSE}.}\r
\item{rotate.colnames}{If \code{TRUE}, the column names are displayed\r
- vertically in LaTeX. }\r
+ vertically in LaTeX.\r
+ Default value is \code{FALSE}.}\r
\item{booktabs}{If \code{TRUE}, the \code{toprule}, \code{midrule} and\r
- \code{bottomrule} tags from the LaTex "booktabs" package are used\r
+ \code{bottomrule} commands from the LaTeX "booktabs" package are used\r
rather than \code{hline} for the horizontal line tags. }\r
\item{scalebox}{If not \code{NULL}, a \code{scalebox} clause will be\r
added around the tabular environment with the specified value used\r
- as the scaling factor. }\r
+ as the scaling factor.\r
+ Default value is \code{NULL}.}\r
\item{width}{If not \code{NULL}, the specified value is included in\r
- parenthesis between the tabular environment \code{begin} tag and the\r
+ parentheses between the tabular environment \code{begin} tag and the\r
alignment specification. This allows specification of the table\r
width when using tabular environments such as \code{tabular*} and\r
\code{tabularx}. Note that table width specification is not\r
- supported with the \code{tabular} or \code{longtable} environments. }\r
+ supported with the \code{tabular} or \code{longtable} environments.\r
+ Default value is \code{NULL}.}\r
\item{comment}{If \code{TRUE}, the version and timestamp comment is\r
- included. Default value is \code{TRUE}. } \r
+ included. Default value is \code{TRUE}. }\r
\item{timestamp}{Timestamp to include in LaTeX comment. Set this\r
- to \code{NULL} to exclude the timestamp. Default value is \code{date()}. } \r
+ to \code{NULL} to exclude the timestamp. Default value is \code{date()}. }\r
\item{...}{Additional arguments. (Currently ignored.) }\r
}\r
\details{\r
This function displays or writes to disk the code to produce a table\r
- associated with an object \code{x} of class \code{"xtable"}. \r
+ associated with an object \code{x} of class \code{"xtable"}.\r
The resulting code is either a LaTeX or HTML table, depending on the\r
value of \code{type}. The function also (invisibly) returns a\r
character vector of the results (which can be helpful for\r
Since version 1.4 the non default behavior of \code{hline.after} is\r
changed. To obtain the same results as the previous versions add to\r
the \code{hline.after} vector the vector \code{c(-1, 0, nrow(x))}\r
- where \code{nrow(x)} is the numbers of rows of the object. \r
+ where \code{nrow(x)} is the numbers of rows of the object.\r
\r
From version 1.4-3, all non-numeric columns are sanitized, and all\r
- LaTeX special characters are sanitised for LaTeX output. See Section\r
- 3 of the \code{xtableGallery} vignette for an example of customising\r
+ LaTeX special characters are sanitized for LaTeX output. See Section\r
+ 3 of the \code{xtableGallery} vignette for an example of customizing\r
the sanitization. From version 1.4-4, the sanitization also applies to\r
column names. To remove any text sanitization, specify\r
- \code{sanitize.text.function=function(x){x}}. \r
- \r
+ \code{sanitize.text.function=function(x){x}}.\r
+\r
From version 1.6-1 the default values for the arguments other than\r
- \code{x} are obtainined using \code{getOption()}. Hence the user can\r
+ \code{x} are obtained using \code{getOption()}. Hence the user can\r
set the values once with \code{options()} rather than setting them in\r
- every call to \code{print.xtable()}. \r
+ every call to \code{print.xtable()}.\r
+\r
+ The argument \code{format.args} is used to supply arguments to the\r
+ \code{formatC} function, but will throw an error if values for\r
+ \code{digits} or \code{format} are included in the list of\r
+ arguments. The recommended approach to specify \code{digits} is to supply\r
+ the argument \code{digits} to \code{xtable}, and to specify\r
+ \code{format} supply the argument \code{display} to \code{xtable}. See\r
+ the examples.\r
}\r
\author{\r
- David Dahl \email{dahl@stat.tamu.edu} with contributions and\r
+ David Dahl \email{dahl@stat.byu.edu} with contributions and\r
suggestions from many others (see source code).\r
}\r
\references{\r
- Fairbairns, Robin (2005) \emph{Tables longer than a single page} The\r
+ Fairbairns, Robin (2005) \emph{Tables longer than a single page.} The\r
UK List of TeX Frequently Asked Questions on the\r
Web. \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=longtab}\r
}\r
\seealso{\r
- \code{\link{xtable}}, \code{\link{caption}}, \code{\link{label}}, \r
+ \code{\link{xtable}}, \code{\link{caption}}, \code{\link{label}},\r
\code{\link{align}}, \code{\link{digits}}, \code{\link{display}},\r
- \code{\link{formatC}} \r
+ \code{\link{formatC}}\r
+}\r
+\r
+\examples{\r
+df <- data.frame(A = c(1.00123, 33.1, 6),\r
+ B = c(111111, 3333333, 3123.233))\r
+## The following code gives the error\r
+## formal argument "digits" matched by multiple actual arguments\r
+## print(xtable(df, display = c("s","e","e")),\r
+## format.args = list(digits = 3, big.mark = " ", decimal.mark = ","))\r
+## specify digits as argument to xtable instead\r
+print(xtable(df, display = c("s","f","f"), digits = 4),\r
+ format.args = list(big.mark = " ", decimal.mark = ","))\r
+## The following code gives the error\r
+## formal argument "format" matched by multiple actual arguments\r
+## print(xtable(df, digits = 4),\r
+## format.args = list(format = c("s","e","e"),\r
+## big.mark = " ", decimal.mark = ","))\r
+## specify format using display argument in xtable\r
+print(xtable(df, display = c("s","e","e"), digits = 4),\r
+ format.args = list(big.mark = " ", decimal.mark = ","))\r
+\r
}\r
\r
\keyword{print}\r
projects / xtable.git / blobdiff