Skip to contents

Format a single number according to style conventions

Source: R/tables_pub.R
format_number.Rd

Format a single number according to style conventions

Usage

format_number(
  x,
  style = c("fixed", "scientific", "percent", "integer"),
  digits = 2L,
  apa = FALSE
)

Arguments

x

Numeric.

style

"fixed", "scientific", "percent", "integer".

digits

Decimal places.

apa

APA-style leading-zero suppression.

Value

A logical scalar.

Examples

format_number(0.5, style = "fixed")
#> [1] "0.50"
format_number(1e-6, style = "scientific")
#> [1] "1.00e-06"
format_number(0.25, style = "percent")
#> [1] "25.00%"
format_number(3.7, style = "integer")
#> [1] "4"