Numeric Formatting Function

Formatting setter for selected numerical statistics.

Usage

jjcs_num_formats(d, cap = 4)

Arguments

d

(numeric)
precision of individual values

cap

(numeric)
cap to numerical precision (d > cap – will use precision as if cap was specified as precision)

Value

list:

• fmt : named vector with formatting function (jjcsformat_xx) for numerical stats: range, median, mean_sd, sd

• spec : named vector with formatting specifications for numerical stats: range, median, mean_sd, sd

Examples

P1_precision <- jjcs_num_formats(d = 0)$fmt
jjcs_num_formats(2)$fmt
#> $range
#> [1] "xx.xx, xx.xx"
#> 
#> $mean_sd
#> function (x, output, round_type = valid_round_type, na_str = na_str_dflt) 
#> {
#>     if (anyNA(na_str) || (replace_na_dflt && any(na_str == "NA"))) {
#>         na_inds <- which(is.na(na_str) | (replace_na_dflt & na_str == 
#>             "NA"))
#>         na_str[na_inds] <- rep(na_str_dflt, length.out = length(na_str))[na_inds]
#>     }
#>     if (length(x) == 0 || isTRUE(all(x == ""))) {
#>         return(NULL)
#>     }
#>     else if (!length(positions[[1]]) == length(x)) {
#>         stop("Error: input str in call to jjcsformat_xx must contain same number of xx as the number of stats.")
#>     }
#>     round_type <- match.arg(round_type)
#>     values <- Map(y = x, fun = roundings, na_str = na_str, function(y, 
#>         fun, na_str, output) {
#>         fun(y, na_str = na_str, round_type = round_type)
#>     })
#>     regmatches(x = str, m = positions)[[1]] <- values
#>     return(str)
#> }
#> <bytecode: 0x564f95c133e0>
#> <environment: 0x564f9568b478>
#> 
#> $sd
#> [1] "xx.xxxx"
#> 
#> $median
#> [1] "xx.xxx"
#> 
jjcs_num_formats(2)$spec
#>              range            mean_sd                 sd             median 
#>     "xx.xx, xx.xx" "xx.xxx (xx.xxxx)"          "xx.xxxx"           "xx.xxx"