Converts a (possibly compound) value into a string using the format information

Converts a (possibly compound) value into a string using the format information

Usage

format_value(
  x,
  format = NULL,
  output = c("ascii", "html"),
  na_str = "NA",
  round_type = valid_round_type
)

Arguments

x

(ANY)
the value to be formatted.

format

(string or function)
the format label (string) or formatter function to apply to x.

output

(string)
output type.

na_str

(character)
character vector to display when the values of x are missing. If only one string is provided, it is applied for all missing values. Defaults to "NA".

round_type

(string)
.
The type of rounding to perform. Allowed values: ("iec", "iec_mod" or "sas")
iec, the default, and iec_mod performs rounding compliant with IEC 60559 (see notes in round_fmt()), while sas performs nearest-value rounding consistent with rounding within SAS.
In addition, the rounding of a negative number that rounds to zero will be presented as 0 (with the appropriate number of trailing zeros) for both sas and iec_mod, while for iec, it will be presented as -0 (with the appropriate number of trailing zeros).

Value

Formatted text representing the cell x.

Details

A length-zero value for na_str will be interpreted as "NA".

See also

round_fmt()

Examples

x <- format_value(pi, format = "xx.xx")
x
#> [1] "3.14"

format_value(x, output = "ascii")
#> [1] "3.14"

# na_str works with multiple values
format_value(c(NA, 1, NA), format = "xx.x (xx.x - xx.x)", na_str = c("NE", "<missing>"))
#> [1] "NE (1.0 - <missing>)"