\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
+ \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 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
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 is\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 is\r
printed.\r
Default value is \code{TRUE}.}\r
- \item{only.contents}{logical. If \code{TRUE} only the rows of the\r
+ \item{only.contents}{If \code{TRUE} only the rows of the\r
table is 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
$-$ for the negative sign (as was the behavior prior to version 1.5-3).\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{digits} and \code{format} arguments should not be\r
- included in this list. See details. }\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
\item{timestamp}{Timestamp to include in LaTeX comment. Set this\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
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 is to specify \code{digits} supply\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
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
\item{x}{An R object of class found among \code{methods(xtable)}. See
below on how to write additional method functions for \code{xtable}.}
\item{caption}{Character vector of length 1 or 2 containing the
- table's caption or title. If length 2, the second item is the
+ table's caption or title. If length is 2, the second item is the
"short caption" used when LaTeX generates a "List of Tables". Set to
\code{NULL} to suppress the caption. Default value is \code{NULL}. }
\item{label}{Character vector of length 1 containing the LaTeX label
or HTML anchor. Set to \code{NULL} to suppress the label. Default
value is \code{NULL}. }
\item{align}{Character vector of length equal to the number of columns
- of the resulting table indicating the alignment of the corresponding
+ of the resulting table, indicating the alignment of the corresponding
columns. Also, \code{"|"} may be used to produce vertical lines
between columns in LaTeX tables, but these are effectively ignored
when considering the required length of the supplied vector. If a
one greater than \code{ncol(x)} if \code{x} is a
\code{data.frame}. Use \code{"l"}, \code{"r"}, and \code{"c"} to
denote left, right, and center alignment, respectively. Use
- \code{"p\{3cm\}"} etc for a LaTeX column of the specified width. For
+ \code{"p\{3cm\}"} etc. for a LaTeX column of the specified width. For
HTML output the \code{"p"} alignment is interpreted as \code{"l"},
ignoring the width request. Default depends on the class of
\code{x}. }
Numeric vector of length equal to one (in which case it will be
replicated as necessary) or to the number of columns of the
resulting table \bold{or} matrix of the same size as the resulting
- table indicating the number of digits to display in the
+ table, indicating the number of digits to display in the
corresponding columns. Since the row names are printed in the first
column, the length of the vector \code{digits} or the number of
columns of the matrix \code{digits} is one greater than
\code{ncol(x)} if \code{x} is a \code{data.frame}. Default depends
- of class of \code{x}. If values of \code{digits} are negative, the
+ on the class of \code{x}. If values of \code{digits} are negative, the
corresponding values of \code{x} are displayed in scientific format
with \code{abs(digits)} digits.}
\item{display}{
Character vector of length equal to the number of columns of the
- resulting table indicating the format for the corresponding columns.
+ resulting table, indicating the format for the corresponding columns.
Since the row names are printed in the first column, the length of
\code{display} is one greater than \code{ncol(x)} if \code{x} is a
\code{data.frame}. These values are passed to the \code{formatC}
an object of class \code{"xtable"}. The nature of the table generated
depends on the class of \code{x}. For example, \code{aov} objects
produce ANOVA tables while \code{data.frame} objects produce a table
- of the entire data.frame. One can optionally provide a caption
+ of the entire data frame. One can optionally provide a caption
(called a title in HTML) or label (called an anchor in HTML), as well
as formatting specifications. Default values for \code{align},
\code{digits}, and \code{display} are class dependent.
The available method functions for \code{xtable} are given by
\code{methods(xtable)}. Users can extend the list of available
classes by writing methods for the generic function \code{xtable}.
- These methods functions should have \code{x} as their first argument
+ These methods functions should have \code{x} as their first argument,
with additional arguments to specify \code{caption}, \code{label},
\code{align}, \code{digits}, and \code{display}. Optionally, other
- arguments may be present to specify how the object \code{x} should be
+ arguments may be passed to specify how the object \code{x} should be
manipulated. All method functions should return an object whose class
- if given by \code{c("xtable","data.frame")}. The resulting object can
+ is \code{c("xtable","data.frame")}. The resulting object can
have attributes \code{caption} and \code{label}, but must have
attributes \code{align}, \code{digits}, and \code{display}. It is
strongly recommened that you set these attributes through the provided
projects / xtable.git / commitdiff