quote = FALSE,
method = c("non.compact", "row.compact",
"col.compact", "compact"),
- lsep = " | ", ...)
+ lsep = " $\\\\vert$ ", ...)
\method{print}{xtableFtable}(x,
type = getOption("xtable.type", "latex"),
NA.string = getOption("xtable.NA.string", ""),
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.text.function = getOption("xtable.sanitize.text.function",
+ function(x){x}),
sanitize.rownames.function = getOption("xtable.sanitize.rownames.function",
sanitize.text.function),
sanitize.colnames.function = getOption("xtable.sanitize.colnames.function",
denote left, right, and center alignment, respectively. Use
\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.
+ ignoring the width request.
If \code{NULL} all row variable labels will be left aligned,
separated from the data columns by a vertical line, and all data
columns will be right aligned. The actual length of \code{align}
\item{quote}{a character string giving the set of quoting characters
for \code{format.ftable} used in \code{print.xtableFtable}; to
disable quoting altogether, use \code{quote=""}.}
-
+
\item{method}{string specifying how the \code{"xtableFtable"} object is
printed in the \code{print} method. Can be abbreviated. Available
- methods are (see the examples in \code{\link{print.ftable}}):
+ methods are (see the examples in \code{\link{print.ftable}}):
\describe{
\item{"non.compact"}{the default representation of an
\code{"ftable"} object.}
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 \code{NULL}. }
+ Default value is \code{NULL}. }
\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. Repeated values are
The default uses the \code{sanitize.text.function}. }
\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}.}
+ Default value is \code{FALSE}.}
\item{math.style.exponents}{In a LaTeX table, if \code{TRUE} or
\code{"$$"}, then use \verb{$5 \times 10^{5}$} for 5e5. If
\code{"ensuremath"}, then use \verb{\\ensuremath{5 \times 10^{5}}}
included in this list.
Default value is \code{NULL}.}
\item{rotate.rownames}{If \code{TRUE}, the row names and labels, and
- column variable names are displayed vertically in LaTeX.
+ column variable names are displayed vertically in LaTeX.
Default value is \code{FALSE}.}
\item{rotate.colnames}{If \code{TRUE}, the column names and labels,
and row variable names are displayed vertically in LaTeX.
\item{comment}{If \code{TRUE}, the version and timestamp comment is
included. Default value is \code{TRUE}. }
\item{timestamp}{Timestamp to include in LaTeX comment. Set this
- to \code{NULL} to exclude the timestamp. Default value is \code{date()}. }
+ to \code{NULL} to exclude the timestamp. Default value is
+ \code{date()}. }
\item{...}{Additional arguments. (Currently ignored.) }
}
\details{
For \code{print.xtableFtable} a character string which will produce a
formatted table when included in a LaTeX document.
-
+
}
\references{
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}
+ Web. \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=longtab}
}
\author{
David Scott \email{d.scott@auckland.ac.nz}.
}
\note{
+ The functions \code{xtableFtable} and \code{print.xtableFtable} are
+ new and their behaviour may change in the future based on user
+ experience and recommendations.
+
It is not recommended that users change the values of \code{align},
\code{digits} or \code{align}. First of all, alternative values have
not been tested. Secondly, it is most likely that to determine
--- /dev/null
+\name{xtableList}\r
+\alias{xtableList}\r
+\alias{print.xtableList}\r
+\r
+\title{\r
+ Create and Export Lists of Tables\r
+}\r
+\description{\r
+ \code{xtableList} creates an object which contains information about\r
+ lists of table which can be used by \code{print.xtableList} to produce\r
+ a character string which when included in a document produces a nicely\r
+ formatted table made up of the information in the individual tables\r
+ which comprised the original list of tables.\r
+}\r
+\usage{\r
+xtableList(x, caption = NULL, label = NULL,\r
+ align = NULL, digits = NULL, display = NULL, ...)\r
+\r
+\method{print}{xtableList}(x,\r
+ type = getOption("xtable.type", "latex"),\r
+ file = getOption("xtable.file", ""),\r
+ append = getOption("xtable.append", FALSE),\r
+ floating = getOption("xtable.floating", TRUE),\r
+ floating.environment = getOption("xtable.floating.environment", "table"),\r
+ table.placement = getOption("xtable.table.placement", "ht"),\r
+ caption.placement = getOption("xtable.caption.placement", "bottom"),\r
+ caption.width = getOption("xtable.caption.width", NULL),\r
+ latex.environments = getOption("xtable.latex.environments", c("center")),\r
+ tabular.environment = getOption("xtable.tabular.environment", "tabular"),\r
+ size = getOption("xtable.size", NULL),\r
+ hline.after = NULL,\r
+ NA.string = getOption("xtable.NA.string", ""),\r
+ include.rownames = getOption("xtable.include.rownames", TRUE),\r
+ colnames.format = "single",\r
+ only.contents = getOption("xtable.only.contents", FALSE),\r
+ 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.text.function),\r
+ sanitize.colnames.function = getOption("xtable.sanitize.colnames.function",\r
+ sanitize.text.function),\r
+ sanitize.subheadings.function =\r
+ getOption("xtable.sanitize.subheadings.function",\r
+ sanitize.text.function),\r
+ sanitize.message.function =\r
+ getOption("xtable.sanitize.message.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", "border=1"),\r
+ print.results = getOption("xtable.print.results", TRUE),\r
+ format.args = getOption("xtable.format.args", NULL),\r
+ rotate.rownames = getOption("xtable.rotate.rownames", FALSE),\r
+ rotate.colnames = getOption("xtable.rotate.colnames", FALSE),\r
+ booktabs = getOption("xtable.booktabs", FALSE),\r
+ scalebox = getOption("xtable.scalebox", NULL),\r
+ width = getOption("xtable.width", NULL),\r
+ comment = getOption("xtable.comment", TRUE),\r
+ timestamp = getOption("xtable.timestamp", date()),\r
+ ...)\r
+}\r
+\arguments{\r
+ \item{x}{For \code{xtableList}, a list of \R objects all of the same\r
+ class, being a class found among \code{methods(xtable)}.\r
+ For \code{print.xtableList}, an object of class \code{xtableList}\r
+ produced by a call to \code{xtableList}.}\r
+ \item{caption}{Character vector of length 1 or 2 containing the\r
+ table's caption or title. If length is 2, the second item is the\r
+ "short caption" used when LaTeX generates a "List of Tables". Set to\r
+ \code{NULL} to suppress the caption. Default value is \code{NULL}. }\r
+ \item{label}{Character vector of length 1 containing the LaTeX label\r
+ or HTML anchor. Set to \code{NULL} to suppress the label. Default\r
+ value is \code{NULL}. }\r
+ \item{align}{Character vector of length equal to the number of columns\r
+ of the resulting table, indicating the alignment of the corresponding\r
+ columns. Also, \code{"|"} may be used to produce vertical lines\r
+ between columns in LaTeX tables, but these are effectively ignored\r
+ when considering the required length of the supplied vector. If a\r
+ character vector of length one is supplied, it is split as\r
+ \code{strsplit(align, "")[[1]]} before processing. Since the row\r
+ names are printed in the first column, the length of \code{align} is\r
+ one greater than \code{ncol(x)} if \code{x} is a\r
+ \code{data.frame}. Use \code{"l"}, \code{"r"}, and \code{"c"} to\r
+ denote left, right, and center alignment, respectively. Use\r
+ \code{"p{3cm}"} etc. for a LaTeX column of the specified width. For\r
+ HTML output the \code{"p"} alignment is interpreted as \code{"l"},\r
+ ignoring the width request. Default depends on the class of\r
+ \code{x}. }\r
+ \item{digits}{\r
+ Either \code{NULL}, or a vector of length one, or a vector of length\r
+ equal to the number of columns in the resulting table, indicating\r
+ the number of digits to display in the corresponding columns, or a\r
+ list if length equal to the number of R objects making up \code{x},\r
+ all members being vectors of the same length, either length one or\r
+ of length equal to the number of columns in the resulting table. See\r
+ \sQuote{Details} for further information.}\r
+ \item{display}{\r
+ Either \code{NULL}, or a vector of length one, or a vector of length\r
+ equal to the number of columns in the resulting table, indicating\r
+ the format of the corresponding columns, or a\r
+ list if length equal to the number of R objects making up \code{x},\r
+ all members being vectors of the same length, either length one or\r
+ of length equal to the number of columns in the resulting table. See\r
+ \sQuote{Details} for further information.}\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
+ \code{file=""}, output is displayed on screen. Note that the\r
+ function also (invisibly) returns a character vector of the results\r
+ (which can be helpful for post-processing).\r
+ Default value is \code{""}.}\r
+ \item{append}{If \code{TRUE} and \code{file!=""}, code will be\r
+ appended to \code{file} instead of overwriting \code{file}.\r
+ Default value is \code{FALSE}.}\r
+ \item{floating}{If \code{TRUE} and \code{type="latex"}, the resulting\r
+ table will be a floating table (using, for example,\r
+ \code{\\begin\{table\}} and \code{\\end\{table\}}). See\r
+ \code{floating.environment} below.\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
+ 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{type="latex"}, the floating table will have placement given by\r
+ \code{table.placement} where \code{table.placement} must be\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 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
+ \item{caption.width}{The caption will be placed in a \code{"parbox"}\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 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
+ When working with tables that extend more than one page, using\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 the number of rows in the resulting table, inclusive,\r
+ indicating the rows after which a horizontal line should\r
+ appear. Determining row numbers is not straightforward since some\r
+ lines in the resulting table don't enter into the count. The\r
+ default depends on the value of \code{col.names.format}.}\r
+ \item{NA.string}{String to be used for missing values in table\r
+ entries.\r
+ Default value is \code{""}.}\r
+ \item{include.rownames}{If \code{TRUE} the rows names are\r
+ printed.\r
+ Default value is \code{TRUE}.}\r
+ \item{colnames.format}{Either \code{"single"} or \code{"multiple"}.\r
+ Default is \code{"single"}.}\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 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 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 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 \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
+ 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
+ \item{sanitize.colnames.function}{Like the\r
+ \code{sanitize.text.function}, but applicable to column names.\r
+ The default uses the \code{sanitize.text.function}. }\r
+ \item{sanitize.subheadings.function}{Like the\r
+ \code{sanitize.text.function}, but applicable to subheadings.\r
+ The default uses the \code{sanitize.text.function}. }\r
+ \item{sanitize.message.function}{Like the\r
+ \code{sanitize.text.function}, but applicable to the message.\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
+ \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
+ 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
+ ","))}. 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
+ Default value is \code{FALSE}.}\r
+ \item{rotate.colnames}{If \code{TRUE}, the column names are displayed\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} 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
+ Default value is \code{NULL}.}\r
+ \item{width}{If not \code{NULL}, the specified value is included in\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
+ 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
+ to \code{NULL} to exclude the timestamp. Default value is\r
+ \code{date()}. }\r
+ \item{\dots}{Additional arguments. (Currently ignored.)}\r
+}\r
+\details{\r
+%% ~~ If necessary, more details than the description above ~~\r
+}\r
+\value{\r
+%% ~Describe the value returned\r
+%% If it is a LIST, use\r
+%% \item{comp1 }{Description of 'comp1'}\r
+%% \item{comp2 }{Description of 'comp2'}\r
+%% ...\r
+}\r
+\author{\r
+ David Scott \email{d.scott@auckland.ac.nz}.\r
+}\r
+\note{\r
+ The functions \code{xtableList} and \code{print.xtableList} are\r
+ new and their behaviour may change in the future based on user\r
+ experience and recommendations.\r
+}\r
+\r
+\r
+\seealso{\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
+}\r
+\examples{\r
+}\r
+\keyword{ print }\r
projects / xtable.git / commitdiff