From 674cd65440512b122866c66d79ad033afe05d3cc Mon Sep 17 00:00:00 2001 From: arnima Date: Sun, 14 Sep 2014 18:05:03 +0000 Subject: [PATCH] Fixed typos in help pages git-svn-id: svn://scm.r-forge.r-project.org/svnroot/xtable@47 edb9625f-4e0d-4859-8d74-9fd3b1da38cb --- pkg/man/print.xtable.Rd | 81 ++++++++++++++++++++++------------------- pkg/man/tli.Rd | 3 +- pkg/man/xtable.Rd | 20 +++++----- 3 files changed, 56 insertions(+), 48 deletions(-) diff --git a/pkg/man/print.xtable.Rd b/pkg/man/print.xtable.Rd index aeda298..51990b8 100644 --- a/pkg/man/print.xtable.Rd +++ b/pkg/man/print.xtable.Rd @@ -71,7 +71,7 @@ \code{NULL} or contain only elements of \{"h","t","b","p","!","H"\}. Default value is \code{"ht"}.} - \item{caption.placement}{The caption will be have placed at the bottom + \item{caption.placement}{The caption will be 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"}. Default value is \code{"bottom"}.} @@ -79,55 +79,56 @@ of the specified width if \code{caption.width} is not \code{NULL} and \code{type="latex"}. Default value is \code{NULL}.} \item{latex.environments}{If \code{floating=TRUE} and - \code{type="latex"}, the specificed latex environments (provided as + \code{type="latex"}, the specified LaTeX environments (provided as a character vector) will enclose the tabular environment. Default value is \code{"center"}. } \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.} - \item{size}{An arbitrary character vector intended to be used to set + \code{tabular.environment="longtable"} with the corresponding + LaTeX package (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. + Default value is \code{"tabular"}.} + \item{size}{A character vector 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}. } \item{hline.after}{When \code{type="latex"}, a vector of numbers - between -1 and \code{"nrow(x)"}, inclusive, indicating the rows + 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. + no lines are produced. Repeated values are allowed. 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.} + table.} \item{NA.string}{String to be used for missing values in table entries. Default value is \code{""}.} - \item{include.rownames}{logical. If \code{TRUE} the rows names is + \item{include.rownames}{If \code{TRUE} the rows names is printed. Default value is \code{TRUE}.} - \item{include.colnames}{logical. If \code{TRUE} the columns names is + \item{include.colnames}{If \code{TRUE} the columns names is printed. Default value is \code{TRUE}.} - \item{only.contents}{logical. If \code{TRUE} only the rows of the + \item{only.contents}{If \code{TRUE} only the rows of the table is printed. Default value is \code{FALSE}. } - \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 + \item{add.to.row}{A list of two components. The first component (which + should be called 'pos') is a list that 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 + of the same length as 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.} - \item{sanitize.text.function}{All non-numeric enteries (except row and - column names) are sanitised in an attempt to remove characters which + \item{sanitize.text.function}{All non-numeric entries (except row and + column names) are sanitized 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 + \code{sanitize.text.function} is not \code{NULL}, 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.} + function. + Default value is \code{NULL}.} \item{sanitize.rownames.function}{Like the \code{sanitize.text.function}, but applicable to row names. The default uses the \code{sanitize.text.function}. } @@ -138,32 +139,38 @@ $-$ for the negative sign (as was the behavior prior to version 1.5-3). Default value is \code{FALSE}.} \item{html.table.attributes}{In an HTML table, attributes associated - with the \code{}tag. - Default value is \code{border=1}.} + with the \code{
} tag. + Default value is \code{"border=1"}.} \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.} + the character vector that is returned invisibly. + Default value is \code{TRUE}.} \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 = - ","))}. \code{digits} and \code{format} arguments should not be - included in this list. See details. } + ","))}. The arguments \code{digits} and \code{format} should not be + included in this list. See details. + Default value is \code{NULL}.} \item{rotate.rownames}{If \code{TRUE}, the row names are displayed - vertically in LaTeX. } + vertically in LaTeX. + Default value is \code{FALSE}.} \item{rotate.colnames}{If \code{TRUE}, the column names are displayed - vertically in LaTeX. } + vertically in LaTeX. + Default value is \code{FALSE}.} \item{booktabs}{If \code{TRUE}, the \code{toprule}, \code{midrule} and - \code{bottomrule} tags from the LaTex "booktabs" package are used + \code{bottomrule} commands from the LaTeX "booktabs" package are used rather than \code{hline} for the horizontal line tags. } \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. } + as the scaling factor. + Default value is \code{NULL}.} \item{width}{If not \code{NULL}, the specified value is included in - parenthesis between the tabular environment \code{begin} tag and the + parentheses between the tabular environment \code{begin} tag and the alignment specification. This allows specification of the table width when using tabular environments such as \code{tabular*} and \code{tabularx}. Note that table width specification is not - supported with the \code{tabular} or \code{longtable} environments. } + supported with the \code{tabular} or \code{longtable} environments. + Default value is \code{NULL}.} \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 @@ -184,8 +191,8 @@ where \code{nrow(x)} is the numbers of rows of the object. 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 + LaTeX special characters are sanitized for LaTeX output. See Section + 3 of the \code{xtableGallery} vignette for an example of customizing the sanitization. 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}}. @@ -198,7 +205,7 @@ The argument \code{format.args} is used to supply arguments to the \code{formatC} function, but will throw an error if values for \code{digits} or \code{format} are included in the list of - arguments. The recommended approach is to specify \code{digits} supply + arguments. The recommended approach to specify \code{digits} is to supply the argument \code{digits} to \code{xtable}, and to specify \code{format} supply the argument \code{display} to \code{xtable}. See the examples. @@ -208,7 +215,7 @@ suggestions from many others (see source code). } \references{ - Fairbairns, Robin (2005) \emph{Tables longer than a single page} The + 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} } diff --git a/pkg/man/tli.Rd b/pkg/man/tli.Rd index f6c2b43..b1cfb72 100644 --- a/pkg/man/tli.Rd +++ b/pkg/man/tli.Rd @@ -7,7 +7,8 @@ This data set contains math scores and demographic data of Assessment of Academic Skills (TAAS). } \usage{data(tli)} -\format{A data.frame containing 100 observations with the following columns: +\format{A \code{data.frame} containing 100 observations with the + following columns: \describe{ \item{\code{grade}}{Year in school of student} \item{\code{sex}}{Gender of student} diff --git a/pkg/man/xtable.Rd b/pkg/man/xtable.Rd index 005382c..1416c9b 100644 --- a/pkg/man/xtable.Rd +++ b/pkg/man/xtable.Rd @@ -30,14 +30,14 @@ xtable(x, caption = NULL, label = NULL, align = NULL, digits = NULL, \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 @@ -47,7 +47,7 @@ xtable(x, caption = NULL, label = NULL, align = NULL, digits = NULL, 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}. } @@ -55,17 +55,17 @@ xtable(x, caption = NULL, label = NULL, align = NULL, digits = NULL, 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} @@ -87,7 +87,7 @@ xtable(x, caption = NULL, label = NULL, align = NULL, digits = NULL, 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. @@ -95,12 +95,12 @@ xtable(x, caption = NULL, label = NULL, align = NULL, digits = NULL, 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 -- 2.39.2