]> git.donarmstrong.com Git - xtable.git/blobdiff - pkg/man/print.xtable.Rd
Added math.style.exponents option to print.xtable via a change to
[xtable.git] / pkg / man / print.xtable.Rd
index 51990b8e0f010678bb5f31921afc4a250f37d426..c8ca65494056f4f580de933004414c0b3b428fe3 100644 (file)
@@ -30,6 +30,7 @@
   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
@@ -44,7 +45,7 @@
   ...)}\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
     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
+  \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
   \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 is\r
+  \item{include.rownames}{If \code{TRUE} the rows names are\r
     printed.\r
     Default value is \code{TRUE}.}\r
-  \item{include.colnames}{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}{If \code{TRUE} only the rows of the\r
-    table is printed.\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
     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
   \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
 \r