pkg/man/print.xtable.Rd

   1 \name{print.xtable}\r
   2 \alias{print.xtable}\r
   3 \title{Print Export Tables}\r
   4 \description{\r
   5   Function returning and displaying or writing to disk the LaTeX or HTML\r
   6   code associated with the supplied object of class \code{xtable}.\r
   7 }\r
   8 \usage{\r
   9 \method{print}{xtable}(x, \r
  10   type = getOption("xtable.type", "latex"),\r
  11   file = getOption("xtable.file", ""),\r
  12   append = getOption("xtable.append", FALSE),\r
  13   floating = getOption("xtable.floating", TRUE),\r
  14   floating.environment = getOption("xtable.floating.environment", "table"),\r
  15   table.placement = getOption("xtable.table.placement", "ht"),\r
  16   caption.placement = getOption("xtable.caption.placement", "bottom"),\r
  17   latex.environments = getOption("xtable.latex.environments", c("center")),\r
  18   tabular.environment = getOption("xtable.tabular.environment", "tabular"),\r
  19   size = getOption("xtable.size", NULL),\r
  20   hline.after = getOption("xtable.hline.after", c(-1,0,nrow(x))),\r
  21   NA.string = getOption("xtable.NA.string", ""),\r
  22   include.rownames = getOption("xtable.include.rownames", TRUE),\r
  23   include.colnames = getOption("xtable.include.colnames", TRUE),\r
  24   only.contents = getOption("xtable.only.contents", FALSE),\r
  25   add.to.row = getOption("xtable.add.to.row", NULL),\r
  26   sanitize.text.function = getOption("xtable.sanitize.text.function", NULL),\r
  27   sanitize.rownames.function = getOption("xtable.sanitize.rownames.function", \r
  28                                          sanitize.text.function),\r
  29   sanitize.colnames.function = getOption("xtable.sanitize.colnames.function", \r
  30                                          sanitize.text.function),\r
  31   math.style.negative = getOption("xtable.math.style.negative", FALSE),\r
  32   html.table.attributes = getOption("xtable.html.table.attributes",\r
  33                                     "border=1"),\r
  34   print.results = getOption("xtable.print.results", TRUE),\r
  35   format.args = getOption("xtable.format.args", NULL),\r
  36   rotate.rownames = getOption("xtable.rotate.rownames", FALSE),\r
  37   rotate.colnames = getOption("xtable.rotate.colnames", FALSE),\r
  38   booktabs = getOption("xtable.booktabs", FALSE),\r
  39   scalebox = getOption("xtable.scalebox", NULL),\r
  40   width = getOption("xtable.width", NULL),\r
  41   ...)}\r
  42 \arguments{\r
  43   \item{x}{An object of class \code{"xtable"}.}\r
  44   \item{type}{Type of table to produce.  Possible values for \code{type}\r
  45     are \code{"latex"} or \code{"html"}.\r
  46     Default value is \code{"latex"}.}\r
  47   \item{file}{Name of file where the resulting code should be saved.  If\r
  48     \code{file=""}, output is displayed on screen.  Note that the\r
  49     function also (invisibly) returns a character vector of the results\r
  50     (which can be helpful for post-processing).\r
  51     Default value is \code{""}.}\r
  52   \item{append}{If \code{TRUE} and \code{file!=""}, code will be\r
  53     appended to \code{file} instead of overwriting \code{file}.\r
  54     Default value is \code{FALSE}.}\r
  55   \item{floating}{If \code{TRUE} and \code{type="latex"}, the resulting\r
  56     table will be a floating table (using, for example,\r
  57     \code{\\begin\{table\}} and \code{\\end\{table\}}).  See\r
  58     \code{floating.environment} below.\r
  59     Default value is \code{TRUE}. }\r
  60   \item{floating.environment}{If \code{floating=TRUE} and\r
  61     \code{type="latex"}, the resulting table uses the specified floating\r
  62     environment. Possible values are \code{"table"}, \code{"table*"}, or\r
  63     \code{"sidewaystable"} (defined in the LaTeX package\r
  64     'rotating').\r
  65     Default value is \code{"table"}.}\r
  66   \item{table.placement}{If \code{floating=TRUE} and\r
  67     \code{type="latex"}, the floating table will have placement given by\r
  68     \code{table.placement} where \code{table.placement} must be\r
  69     \code{NULL} or contain only elements of\r
  70     \{"h","t","b","p","!","H"\}.\r
  71     Default value is \code{"ht"}.}\r
  72   \item{caption.placement}{The caption will be have placed at the bottom\r
  73     of the table if \code{caption.placement} is \code{"bottom"} and at\r
  74     the top of the table if it equals \code{"top"}.\r
  75     Default value is \code{"bottom"}.}\r
  76   \item{latex.environments}{If \code{floating=TRUE} and\r
  77     \code{type="latex"}, the specificed latex environments (provided as\r
  78     a character vector) will enclose the tabular environment.\r
  79     Default value is \code{"center"}. }\r
  80   \item{tabular.environment}{When \code{type="latex"}, the tabular\r
  81     environment that will be used.\r
  82     Defaults to \code{"tabular"}.\r
  83     When working with tables that extend more than one page, using\r
  84     \code{tabular.environment="longtable"} and the LaTeX package\r
  85     \code{"longtable"} (see Fairbairns, 2005) allows one to typeset them\r
  86     uniformly. Note that \code{"floating"} should be set to\r
  87     \code{"FALSE"} when using the \code{"longtable"} environment.}\r
  88   \item{size}{An arbitrary character vector intended to be used to set\r
  89     the font size in a LaTeX table.  The supplied value (if not\r
  90     \code{NULL}) is inserted just before the tabular environment\r
  91     starts.\r
  92     Default value is \code{NULL}. }\r
  93   \item{hline.after}{When \code{type="latex"}, a vector of numbers\r
  94     between -1 and \code{"nrow(x)"}, inclusive, indicating the rows\r
  95     after which a horizontal line should appear.  If \code{NULL} is used\r
  96     no lines are produced.\r
  97     Default value is \code{c(-1,0,nrow(x))} which means draw a line\r
  98     before and after the columns names and at the end of the\r
  99     table. Repeated values are allowed.}\r
 100   \item{NA.string}{String to be used for missing values in table\r
 101     entries.\r
 102     Default value is \code{""}.}\r
 103   \item{include.rownames}{logical. If \code{TRUE} the rows names is\r
 104     printed.\r
 105     Default value is \code{TRUE}.}\r
 106   \item{include.colnames}{logical. If \code{TRUE} the columns names is\r
 107     printed.\r
 108     Default value is \code{TRUE}.}\r
 109   \item{only.contents}{logical. If \code{TRUE} only the rows of the\r
 110     table is printed.\r
 111     Default value is \code{FALSE}. }\r
 112   \item{add.to.row}{a list of two components. The first component (which\r
 113     should be called 'pos') is a list contains the position of rows on\r
 114     which extra commands should be added at the end, The second\r
 115     component (which should be called 'command') is a character vector\r
 116     of the same length of the first component which contains the command\r
 117     that should be added at the end of the specified rows.\r
 118     Default value is \code{NULL}, i.e. do not add commands.}\r
 119   \item{sanitize.text.function}{All non-numeric enteries (except row and\r
 120     column names) are sanitised in an attempt to remove characters which\r
 121     have special meaning for the output format. If\r
 122     \code{sanitize.text.function} is not NULL (the default), it should\r
 123     be a function taking a character vector and returning one, and will\r
 124     be used for the sanitization instead of the default internal\r
 125     function.}\r
 126   \item{sanitize.rownames.function}{Like the\r
 127     \code{sanitize.text.function}, but applicable to row names.\r
 128     The default uses the \code{sanitize.text.function}. }\r
 129   \item{sanitize.colnames.function}{Like the\r
 130     \code{sanitize.text.function}, but applicable to column names.\r
 131     The default uses the \code{sanitize.text.function}. }\r
 132   \item{math.style.negative}{In a LaTeX table, if \code{TRUE}, then use\r
 133     $-$ for the negative sign (as was the behavior prior to version 1.5-3).\r
 134     Default value is \code{FALSE}.}\r
 135   \item{html.table.attributes}{In an HTML table, attributes associated\r
 136     with the \code{<TABLE>}tag.\r
 137     Default value is \code{border=1}.}\r
 138   \item{print.results}{If \code{TRUE}, the generated table is printed to\r
 139     standard output.  Set this to \code{FALSE} if you will just be using\r
 140     the character vector that is returned invisibly.}\r
 141   \item{format.args}{List of arguments for the \code{formatC} function.\r
 142     For example, standard German number separators can be specified as\r
 143     \code{format.args=list(big.mark = "'", decimal.mark = ","))}. }\r
 144   \item{rotate.rownames}{If \code{TRUE}, the row names are displayed\r
 145     vertically in LaTeX. }\r
 146   \item{rotate.colnames}{If \code{TRUE}, the column names are displayed\r
 147     vertically in LaTeX. }\r
 148   \item{booktabs}{If \code{TRUE}, the \code{toprule}, \code{midrule} and\r
 149     \code{bottomrule} tags from the LaTex "booktabs" package are used\r
 150     rather than \code{hline} for the horizontal line tags. }\r
 151   \item{scalebox}{If not \code{NULL}, a \code{scalebox} clause will be\r
 152     added around the tabular environment with the specified value used\r
 153     as the scaling factor. }\r
 154   \item{width}{If not \code{NULL}, the specified value is included in\r
 155     parenthesis between the tabular environment \code{begin} tag and the\r
 156     alignment specification.  This allows specification of the table\r
 157     width when using tabular environments such as \code{tabular*} and\r
 158     \code{tabularx}.  Note that table width specification is not\r
 159     supported with the \code{tabular} or \code{longtable} environments. }\r
 160   \item{...}{Additional arguments.  (Currently ignored.)}\r
 161 }\r
 162 \details{\r
 163   This function displays or writes to disk the code to produce a table\r
 164   associated with an object \code{x} of class \code{"xtable"}. \r
 165   The resulting code is either a LaTeX or HTML table, depending on the\r
 166   value of \code{type}.  The function also (invisibly) returns a\r
 167   character vector of the results (which can be helpful for\r
 168   post-processing).\r
 169 \r
 170   Since version 1.4 the non default behavior of \code{hline.after} is\r
 171   changed. To obtain the same results as the previous versions add to\r
 172   the \code{hline.after} vector the vector \code{c(-1, 0, nrow(x))}\r
 173   where \code{nrow(x)} is the numbers of rows of the object. \r
 174 \r
 175   From version 1.4-3, all non-numeric columns are sanitized, and all\r
 176   LaTeX special characters are sanitised for LaTeX output.  See Section\r
 177   3 of the \code{xtableGallery} vignette for an example of customising\r
 178   the sanitization. From version 1.4-4, the sanitization also applies to\r
 179   column names.  To remove any text sanitization, specify\r
 180   \code{sanitize.text.function=function(x){x}}.  \r
 181   \r
 182   From version 1.6-1 the default values for the arguments other than\r
 183   \code{x} are obtainined using \code{getOption()}.  Hence the user can\r
 184   set the values once with \code{options()} rather than setting them in\r
 185   every call to \code{print.xtable()}. \r
 186 }\r
 187 \author{\r
 188   David Dahl \email{dahl@stat.tamu.edu} with contributions and\r
 189   suggestions from many others (see source code).\r
 190 }\r
 191 \references{\r
 192   Fairbairns, Robin (2005) \emph{Tables longer than a single page} The\r
 193   UK List of TeX Frequently Asked Questions on the\r
 194   Web. \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=longtab}\r
 195 }\r
 196 \seealso{\r
 197   \code{\link{xtable}}, \code{\link{caption}}, \code{\link{label}}, \r
 198   \code{\link{align}}, \code{\link{digits}}, \code{\link{display}},\r
 199   \code{\link{formatC}} \r
 200 }\r
 201 \r
 202 \keyword{print}\r