Convert a vector of numbers to a cardinal numeral (e.g. one tenth, one, two).
number_friendly_safe() checks that all arguments are of the correct type
and raises an informative error otherwise. number_friendly() does not
perform input validation to maximize its speed.
number_friendly(numbers, ...)# S3 method for numeric
number_friendly(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
decimal = " and ",
and = FALSE,
hyphenate = TRUE,
and_fractional = and,
hyphenate_fractional = hyphenate,
english_fractions = NULL,
...
)
# S3 method for integer
number_friendly(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
and = FALSE,
hyphenate = TRUE,
...
)
# S3 method for bignum_biginteger
number_friendly(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
and = FALSE,
hyphenate = TRUE,
...
)
# S3 method for bignum_bigfloat
number_friendly(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
decimal = " and ",
and = FALSE,
hyphenate = TRUE,
and_fractional = and,
hyphenate_fractional = hyphenate,
english_fractions = NULL,
...
)
# S3 method for default
number_friendly(numbers, ...)
number_friendly_safe(numbers, ...)
# S3 method for numeric
number_friendly_safe(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
decimal = " and ",
and = FALSE,
hyphenate = TRUE,
and_fractional = and,
hyphenate_fractional = hyphenate,
english_fractions = NULL,
...
)
# S3 method for integer
number_friendly_safe(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
and = FALSE,
hyphenate = TRUE,
...
)
# S3 method for bignum_biginteger
number_friendly_safe(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
and = FALSE,
hyphenate = TRUE,
...
)
# S3 method for bignum_bigfloat
number_friendly_safe(
numbers,
zero = "zero",
na = "missing",
nan = "not a number",
inf = "infinity",
negative = "negative ",
decimal = " and ",
and = FALSE,
hyphenate = TRUE,
and_fractional = and,
hyphenate_fractional = hyphenate,
english_fractions = NULL,
...
)
# S3 method for default
number_friendly_safe(numbers, ...)
A non-NA character vector of the same length as numbers.
A vector of numbers to translate. The friendlynumber package defines
methods for integer, numeric, bignum::biginteger(), and
bignum::bigfloat() numbers.
Integers are passed to integerish_friendly()
Numeric vectors are passed to numeric_friendly()
bignum::biginteger() vectors are passed to biginteger_friendly()
bignum::bigfloat() vectors are passed to bigfloat_friendly()
Additional arguments passed to or from other methods.
[character(1)]
What to call values of 0 in numbers (e.g. zero = "zero").
[character(1)]
What to call values of NA in numbers (e.g. na = "missing").
[character(1)]
What to call values of NaN in numbers (e.g. nan = "undefined").
[character(1)]
What to call values of Inf in numbers (e.g. inf = "infinity").
[character(1)]
A prefix added to the translation of negative elements of numbers.
negative is the string "negative " by default.
[character(1)]
A word inserted between the whole and fractional part of translated
numbers. decimal is the string " and " by default.
[TRUE / FALSE]
Whether to insert an " and " before the tens place of translated numbers.
and is FALSE by default.
[TRUE / FALSE]
Whether to hyphenate numbers 21 through 99 (e.g. "twenty-one" vs. "twenty one").
hyphenate is TRUE by default.
[TRUE / FALSE]
Whether to insert an " and " before the smallest fractional tens place
of translated numbers (e.g. "one hundred one thousandths" vs.
"one hundred and one thousandths").
and_fractional is equal to and by default.
[TRUE / FALSE]
Whether to hyphenate numbers 21 through 99 in the fractional part of translated
numbers (e.g. "twenty-one hundredths" or "twenty one hundredths"). This
also determines the hyphenation of the fractional units (e.g. "one ten-millionth"
vs. "one ten millionth").
hyphenate_fractional is equal to hyphenate by default.
[character]
A named character vector used as a dictionary for the translation of the
fractional part of numbers. The names (i.e. keys) are the decimal digits
of a fractional number and the values are the corresponding translations.
For example english_fractions = c("5" = "a half") matches the number
0.5 (translated as "a half") and 2.5 (translated as "two and a half").
By default english_fractions is a named character vector with translations
for fractions x / y for x = 1, 2, ..., 8 and y = 1, 2, ..., 9. For
example, 2 / 3 is translated as "two thirds" and 1 / 2 is translated
as "one half".
Provide an empty character to english_fractions to opt out of any such
translations. In this case 1 / 2 is translated as "five tenths" instead
of "one half".
integerish_friendly(), numeric_friendly(),
biginteger_friendly(), bigfloat_friendly()
number_friendly(c(1/3, 0, 0.999, NA, NaN, Inf, -Inf))
number_friendly(c(1L, 2L, 1001L))
# Input validation
try(number_friendly_safe(1L, zero = c("a", "zero")))
Run the code above in your browser using DataLab