From: arnima <arnima@edb9625f-4e0d-4859-8d74-9fd3b1da38cb>
Date: Fri, 26 Sep 2014 17:22:48 +0000 (+0000)
Subject: Explain 'pad' argument in formatHelpers.Rd, and link to this help page
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=e57ea6c724a839cbda79e9b27bb52b1b7e8c8d80;p=xtable.git

Explain 'pad' argument in formatHelpers.Rd, and link to this help page

git-svn-id: svn://scm.r-forge.r-project.org/svnroot/xtable@55 edb9625f-4e0d-4859-8d74-9fd3b1da38cb
---

diff --git a/pkg/man/formatHelpers.Rd b/pkg/man/formatHelpers.Rd
index a990335..ab71bf0 100644
--- a/pkg/man/formatHelpers.Rd
+++ b/pkg/man/formatHelpers.Rd
@@ -3,7 +3,7 @@
 \alias{xdigits}
 \alias{xdisplay}
 \title{Suggest Appropriate Formatting}
-\description{  
+\description{
   Suggest an appropriate \code{xtable} alignment, appropriate number of
   digits, or display type for a vector, or each column of a matrix or
   data frame.
@@ -16,13 +16,13 @@ xdisplay(x, pad = TRUE)
 \arguments{
   \item{x}{a vector, matrix, or data frame.}
   \item{pad}{when \code{x} is two-dimensional, \code{pad = TRUE} inserts
-    an extra \code{"l"} for the row names.}
+    an extra code for the row names: \code{"l"} alignment , \code{0}
+    digits, and \code{"s"} display.}
   \item{zap}{the number of digits passed to \code{zapsmall}.}
-  
 }
 \value{
   A character or a vector of characters, specifying the suggested
-  alignment, number of digits or display type.
+  alignment, number of digits, or display type.
 }
 \author{Arni Magnusson.}
 \seealso{
@@ -39,9 +39,11 @@ head(mtcars)
 xalign(mtcars, pad = FALSE)
 xalign(mtcars, pad = TRUE)
 xtable(mtcars, align = xalign(mtcars))
+
 xdigits(mtcars, pad = FALSE)
 xdigits(mtcars, pad = TRUE)
 xtable(mtcars, digits = xdigits(mtcars))
+
 xdisplay(mtcars, pad = FALSE)
 xdisplay(mtcars, pad = TRUE)
 xtable(mtcars, display = xdisplay(mtcars))
diff --git a/pkg/man/table.attributes.Rd b/pkg/man/table.attributes.Rd
index d9da8a7..ff2be41 100644
--- a/pkg/man/table.attributes.Rd
+++ b/pkg/man/table.attributes.Rd
@@ -43,5 +43,8 @@
   \code{xtable} for a description of the options.
 }
 \author{David Dahl \email{dahl@stat.byu.edu} with contributions and suggestions from many others (see source code).}
-\seealso{\code{\link{xtable}}, \code{\link{print.xtable}}, \code{\link{formatC}}}
+\seealso{
+  \code{\link{xtable}}, \code{\link{print.xtable}},
+  \code{\link{xalign}}, \code{\link{xdigits}}, \code{\link{xdisplay}}
+}
 \keyword{print}