integerish_friendly: Translate integer-ish numbers to a cardinal character vector

In friendlynumber: Translate Numbers into Number Words

Translate integer-ish numbers to a cardinal character vector

Description

Convert an integer vector, or numeric vector which is coercible to an integer without loss of precision, to a cardinal numeral (e.g. one, two, three).

integerish_friendly_safe() checks that all arguments are of the correct type and raises an informative error otherwise. integerish_friendly() does not perform input validation to maximize its speed.

Usage

integerish_friendly(
  numbers,
  zero = "zero",
  na = "missing",
  nan = "not a number",
  inf = "infinity",
  negative = "negative ",
  and = FALSE,
  hyphenate = TRUE
)

integerish_friendly_safe(
  numbers,
  zero = "zero",
  na = "missing",
  nan = "not a number",
  inf = "infinity",
  negative = "negative ",
  and = FALSE,
  hyphenate = TRUE
)

Arguments

numbers	⁠[integer / numeric]⁠ An integer or integer-ish numeric vector to translate.
zero	⁠[character(1)]⁠ What to call values of 0 in numbers (e.g. zero = "zero").
na	⁠[character(1)]⁠ What to call values of NA in numbers (e.g. na = "missing").
nan	⁠[character(1)]⁠ What to call values of NaN in numbers (e.g. nan = "undefined").
inf	⁠[character(1)]⁠ What to call values of Inf in numbers (e.g. inf = "infinity").
negative	⁠[character(1)]⁠ A prefix added to the translation of negative elements of numbers. negative is the string "negative " by default.
and	⁠[TRUE / FALSE]⁠ Whether to insert an " and " before the tens place of translated numbers. and is FALSE by default.
hyphenate	⁠[TRUE / FALSE]⁠ Whether to hyphenate numbers 21 through 99 (e.g. "twenty-one" vs. "twenty one"). hyphenate is TRUE by default.

Value

A non-NA character vector of the same length as numbers.

Examples

integerish_friendly(c(0, 1, 2, NA, NaN, Inf, -Inf))
integerish_friendly(10^10)

# Specify the translations of "special" numbers
integerish_friendly(-10, negative = "minus ")
integerish_friendly(NaN, nan = "undefined")

# Modify the output formatting
integerish_friendly(1234)
integerish_friendly(1234, and = TRUE)
integerish_friendly(1234, hyphenate = FALSE)

# Input validation
try(integerish_friendly_safe(0.5))
try(integerish_friendly_safe(1L, na = TRUE))

friendlynumber documentation built on April 12, 2025, 2:26 a.m.