← Back to branch summary

~showard314/ubuntu/karmic/r-base/remove_start_comments

« back to all changes in this revision

Viewing changes to src/library/base/man/format.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2009-01-19 12:40:24 UTC
  • mfrom: (5.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090119124024-abxsf4e0y7713w9m
Tags: 2.8.1-2
http://bugs.debian.org/512324
debian/control: Add another Build-Depends: exclusion for the 
'kfreebsd-i386 kfreebsd-amd64 hurd-i386' architecture to openjdk-6-jdk.
Thanks to Petr Salinger for the heads-up.               (Closes: 512324)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/library/base/man/format.Rd
21
21
       width = NULL, na.encode = TRUE, scientific = NA,
22
22
       big.mark = "",   big.interval = 3,
23
23
     small.mark = "", small.interval = 5,
24
 
   decimal.mark = ".", zero.print = NULL, \dots)
 
24
   decimal.mark = ".", zero.print = NULL, drop0trailing = FALSE, \dots)
25
25
 
26
26
\method{format}{data.frame}(x, \dots, justify = "none")
27
27
 
51
51
    \code{AsIs} method: the \emph{maximum} field width for non-character
52
52
    objects.  \code{NULL} corresponds to the default 12.
53
53
  }
54
 
  \item{na.encode}{logical: should \code{NA} strings be encoded?}
 
54
  \item{na.encode}{logical: should \code{NA} strings be encoded?  Note
 
55
    this only applies to elements of character vectors, not to numerical
 
56
    or logical \code{NA}s, which are always encoded as \code{"NA"}.}
 
57
  % because Mr Gorjanc won't read, PR#12318
55
58
  \item{scientific}{Either a logical specifying whether
56
59
    elements of a real or complex vector should be encoded in scientific
57
60
    format, or an integer penalty (see \code{\link{options}("scipen")}.
59
62
  \item{\dots}{further arguments passed to or from other methods.}
60
63
 
61
64
  \item{big.mark, big.interval, small.mark,
62
 
    small.interval, decimal.mark, zero.print}{%
63
 
    used for prettying longer decimal sequences, passed to
 
65
    small.interval, decimal.mark, zero.print, drop0trailing}{%
 
66
    used for prettying (longish) decimal sequences, passed to
64
67
    \code{\link{prettyNum}}: that help page explains the details.}
65
68
}
66
69
\details{
99
102
  needed to display all the elements to at least the \code{digit}
100
103
  significant digits.  However, if all the elements then have trailing
101
104
  zeroes, the number of decimal places is reduced until at least one
102
 
  element has a non-zero final digit.
 
105
  element has a non-zero final digit; see also the argument
 
106
  documentation for \code{big.*}, \code{small.*} etc, above.
103
107
 
104
108
  Raw vectors are converted to their 2-digit hexadecimal representation
105
109
  by \code{\link{as.character}}.
106
 
 
107
 
  Character inputs with embedded nul bytes will be truncated at the first nul.
108
110
}
109
111
\value{
110
112
  An object of similar structure to \code{x} containing character
134
136
  formatted.
135
137
 
136
138
  \code{\link{formatC}}, \code{\link{paste}}, \code{\link{as.character}},
137
 
  \code{\link{sprintf}}, \code{\link{print}}, \code{\link{toString}},
138
 
  \code{\link{encodeString}}.
 
139
  \code{\link{sprintf}}, \code{\link{print}}, \code{\link{prettyNum}},
 
140
  \code{\link{toString}}, \code{\link{encodeString}}.
139
141
}
140
142
\examples{
141
143
format(1:10)