Added the "width" argument for use with "tabular*" or "tabularx" tabular environments.

[xtable.git] / pkg / inst / doc / xtableGallery.snw

diff --git a/pkg/inst/doc/xtableGallery.snw b/pkg/inst/doc/xtableGallery.snw
index c69c98e4176719d8a04120dd4ef1be7431bbc1db..6f52a05b4eaf784f0b366b446c91d7c01bdcaac8 100644 (file)
--- a/pkg/inst/doc/xtableGallery.snw
+++ b/pkg/inst/doc/xtableGallery.snw
@@ -32,6 +32,7 @@ The xtable gallery
 \usepackage{rotating} 
 \usepackage{longtable} 
 \usepackage{booktabs}
+\usepackage{tabularx}
 %\usepackage{hyperref}
 \begin{document}
 
@@ -499,6 +500,30 @@ x.rescale <- xtable(x,label='tabrescaled',caption='A rescaled table')
 print(x.rescale, scalebox=0.7)
 @
 
+\subsection{Table Width} 
+The {\tt tabularx} tabular environment provides more alignment options,
+and has a \code{width} argument to specify the table width.
+ 
+Remember to insert \verb|\usepackage{tabularx}| in your \LaTeX preamble.
+
+<<>>=
+df.width <- data.frame(
+  "label 1 with much more text than is needed" = c("item 1", "A"), 
+  "label 2 is also very long" = c("item 2","B"),
+  "label 3" = c("item 3","C"), 
+  "label 4" = c("item 4 but again with too much text","D"),
+  check.names = FALSE)
+
+x.width <- xtable(df.width, 
+  caption="Using the 'tabularx' environment")
+align(x.width) <- "|l|X|X|l|X|"  
+@
+
+<<results=tex>>=
+print(x.width, tabular.environment="tabularx", 
+  width="\\textwidth")
+@
+
 \section{Suppressing Printing}
 By default the {\tt print} method will print the LaTeX or HTML to standard
 output and also return the character strings invisibly.  The printing to