File: autoformat.Rd

package info (click to toggle)
r-cran-xtable 1%3A1.8-4-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 992 kB
  • sloc: sh: 19; makefile: 2
file content (75 lines) | stat: -rw-r--r-- 1,798 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
\name{autoformat}
\alias{autoformat}
\alias{xalign}
\alias{xdigits}
\alias{xdisplay}
\title{Automatically Format Export Tables}
\description{
  Suggest an appropriate alignment, number of digits, and display type
  for \code{xtable}.
}
\usage{
autoformat(xtab, zap = getOption("digits"))

xalign(x, pad = TRUE)
xdigits(x, pad = TRUE, zap = getOption("digits"))
xdisplay(x, pad = TRUE)
}
\arguments{
  \item{xtab}{an object of class \code{xtable}.}
  \item{x}{a vector, matrix, or data frame.}
  \item{pad}{whether to format row names, when \code{x} is
    two-dimensional.}
  \item{zap}{the number of digits passed to \code{zapsmall}.}
}
\value{
  \code{autoformat} returns a copy of \code{xtab}, after applying
  \code{xalign}, \code{xdigits}, and \code{xdisplay}.

  \code{xalign} returns a character vector consisting of \code{"l"} and
  \code{"r"} elements, for left/right alignment.

  \code{xdigits} returns an integer vector.

  \code{xdisplay} returns a character vector of \code{"d"}, \code{"f"},
  and \code{"s"} elements, for integer/double/string display.
}
\author{Arni Magnusson.}
\seealso{
  \code{\link{xtable}}, \code{\link{align}}, \code{\link{digits}},
  \code{\link{display}}
}
\examples{
## 1  Vector
xalign(precip)
xdigits(precip)
xdisplay(precip)


## 2  Data frame
head(mtcars)
xdigits(mtcars, pad = FALSE)
xdigits(mtcars, pad = TRUE)
xalign(mtcars)
xdisplay(mtcars)


## 3  Autoformat when xtable is created
xtable(mtcars, align = xalign(mtcars), digits = xdigits(mtcars),
       display = xdisplay(mtcars))

## equivalent shortcut
xtable(mtcars, auto = TRUE)


## 4  Autoformat existing xtable
mt <- xtable(mtcars)
align(mt) <- xalign(mt)
digits(mt) <- xdigits(mt)
display(mt) <- xdisplay(mt)

## equivalent shortcut
mt <- autoformat(mt)
}
\keyword{array}
\keyword{print}