format {base}R Documentation

Encode in a Common Format

Description

Format an R object for pretty printing: format.pval is intended for formatting p-values.

Usage

format(x, ...)
format.default(x, trim = FALSE, digits = getOption("digits"))
format.pval(x, digits = max(1, getOption("digits") - 2),
            eps = .Machine$double.eps)

Arguments

x any R object (conceptually); typically numeric.
trim logical; if TRUE, leading blanks are trimmed off the strings.
digits how many significant digits are to be used for numeric x. This is a suggestion: enough decimal places will be used so that the smallest (in magnitude) number has this many significant digits.

Details

These functions convert their first argument to a vector (or array) of character strings which have a common format (as is done by print). The trimming with trim = TRUE is useful when the strings are to be used for plot axis annotation.

format.pval is mainly an auxiliary function for print.summary.lm etc., does separate formatting for fixed, floating point and very small values (those < eps).

The function formatC provides a rather more flexible formatting facility for numbers, but does not provide a common format for several numbers.

Note

Currently format loses trailing zeroes, so format(6.001, digits=2) gives "6" and format(c(6.0, 13.1), digits=2) gives c(" 6", "13").

Character(s) " in input strings x are escaped to \".

See Also

formatC, paste, as.character.

Examples

format(1:10)

p <- c(47,13,2,.1,.023,.0045, 1e-100)/1000
format.pval(p)
format.pval(p / 0.9)
format.pval(p / 0.9, dig=3)

[Package Contents]