Skip to contents

Chinese Style Formatting of Numbers

Source: R/label-cn.R
label-cn.Rd

The label_xxx_cn family of functions makes it easy to format numbers in decimal format, as percentages or as currencies.

Usage

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

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

label_currency_cn(
  accuracy = 1,
  scale = 1,
  currency = "CNY",
  prefix = NULL,
  suffix = NULL,
  big.mark = NULL,
  decimal.mark = NULL,
  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

Additional text to display before the number. The suffix is applied to absolute value before style_positive and style_negative are processed so that prefix = "$" will yield (e.g.) -$1 and ($1).

suffix

Additional text to display after the number.

big.mark

Character used between every 3 digits to separate thousands. The default (NULL) retrieves the setting from the number options.

decimal.mark

The character to be used to indicate the numeric decimal point. The default (NULL) retrieves the setting from the number options.

trim

Logical, if FALSE, values are right-justified to a common width (see base::format()).

...

Other arguments passed on to base::format().

currency

currency symbol

Value

A labelling function that takes a numeric vector and returns a character vector.

Details

  • label_number_cn formats numbers in decimal format.

  • label_percent_cn formats numbers as percentages.

  • label_currency_cn formats numbers as currencies.

Examples

# rendered directly (rather than via scales::demo_continuous()) because
# several locales' group/currency signs aren't in the check device's font
label_number_cn()(c(-1e6, 0, 1e6))
#> [1] "-1,000,000" "0"          "1,000,000" 
label_percent_cn(accuracy = .01)(c(-1, 0, 1))
#> [1] "-100.00%" "0.00%"    "100.00%" 
label_currency_cn(accuracy = .1)(c(-1e6, 0, 1e6))
#> [1] "-¥1,000,000.0" "¥0.0"          "¥1,000,000.0"