When reporting ratios, such as relative risk or an odds ratio, we'll often
want the rounding to be similar on each side of the number 1. For example,
if we report an odds ratio of 0.95 with a confidence interval of 0.70 to 1.24,
we would want to round to two decimal places for all values. In other words,
2 significant figures for numbers less than 1 and 3 significant figures 1 and
larger. style_ratio()
performs significant figure-like rounding in this manner.
Arguments
- x
(
numeric
) Numeric vector- digits
(
integer
)
Integer specifying the number of significant digits to display for numbers below 1. Numbers larger than 1 will be bedigits + 1
. Default isdigits = 2
.- big.mark
(
string
)
Character used between every 3 digits to separate hundreds/thousands/millions/etc. Default is","
, except whendecimal.mark = ","
when the default is a space.- decimal.mark
(
string
)
The character to be used to indicate the numeric decimal point. Default is"."
orgetOption("OutDec")
- prefix
(
string
)
Additional text to display before the number.- suffix
(
string
)
Additional text to display after the number.- ...
Arguments passed on to
base::format()
Examples
c(0.123, 0.9, 1.1234, 12.345, 101.234, -0.123, -0.9, -1.1234, -12.345, -101.234) |>
style_ratio()
#> [1] "0.12" "0.90" "1.12" "12.3" "101" "-0.12" "-0.90" "-1.12" "-12.3"
#> [10] "-101"