number: A low-level numeric formatter

In department-for-transport/dftplotr: Functions to Produce Charts in the DfT Style

A low-level numeric formatter

Description

This function is a low-level helper that powers many of the labelling functions. You should generally not need to call it directly unless you are creating your own labelling function.

Usage

number(
  x,
  accuracy = NULL,
  scale = 1,
  prefix = "",
  suffix = "",
  big.mark = " ",
  decimal.mark = ".",
  trim = TRUE,
  ...
)

Arguments

x	A numeric vector to format.
accuracy	A number to round to. Use (e.g.) '0.01' to show 2 decimal places of precision. If 'NULL', the default, uses a heuristic that should ensure breaks have the minimum number of digits needed to show the difference between adjacent values. Applied to rescaled data.
scale	A scaling factor: 'x' will be multiplied by 'scale' before formatting. This is useful if the underlying data is very small or very large.
prefix, suffix	Symbols to display before and after value.
big.mark	Character used between every 3 digits to separate thousands.
decimal.mark	The character to be used to indicate the numeric decimal point.
trim	Logical, if 'FALSE', values are right-justified to a common width (see [base::format()]).
...	Other arguments passed on to [base::format()].

Value

A character vector of 'length(x)'.

department-for-transport/dftplotr documentation built on April 3, 2024, 3:55 p.m.