style_number: Style numbers

In gtsummary: Presentation-Ready Data Summary and Analytic Result Tables

Style numbers

Description

Style numbers

Usage

style_number(
  x,
  digits = 0,
  big.mark = ifelse(decimal.mark == ",", " ", ","),
  decimal.mark = getOption("OutDec"),
  scale = 1,
  prefix = "",
  suffix = "",
  ...
)

Arguments

x	(numeric) Numeric vector
digits	(non-negative integer) Integer or vector of integers specifying the number of decimals to round x. When vector is passed, each integer is mapped 1:1 to the numeric values in x
big.mark	(string) Character used between every 3 digits to separate hundreds/thousands/millions/etc. Default is ",", except when decimal.mark = "," when the default is a space.
decimal.mark	(string) The character to be used to indicate the numeric decimal point. Default is "." or getOption("OutDec")
scale	(scalar numeric) A scaling factor: x will be multiplied by scale before formatting.
prefix	(string) Additional text to display before the number.
suffix	(string) Additional text to display after the number.
...	Arguments passed on to base::format()

Value

formatted character vector

Examples

c(0.111, 12.3) |> style_number(digits = 1)
c(0.111, 12.3) |> style_number(digits = c(1, 0))

gtsummary documentation built on Oct. 5, 2024, 1:06 a.m.