label_number: Label numbers in decimal format (e.g. 0.12, 1,234)

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

Label numbers in decimal format (e.g. 0.12, 1,234)

Description

Use ‘label_number()' force decimal display of numbers (i.e. don’t use [scientific][label_scientific] notation). 'label_comma()' is a special case that inserts a comma every three digits.

Usage

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

Arguments

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()].
x	A numeric vector to format.

Value

All 'label_()' functions return a "labelling" function, i.e. a function that takes a vector 'x' and returns a character vector of 'length(x)' giving a label for each input value.

Labelling functions are designed to be used with the 'labels' argument of ggplot2 scales. The examples demonstrate their use with x scales, but they work similarly for all scales, including those that generate legends rather than axes.

Old interface

'number_format()', 'comma_format()', and 'comma()' are retired; please use 'label_number()' and 'label_comma()' instead.

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