Format a value for printing

Source: R/format.R

This function can be used directly, or via the {.val ...} inline style. {.val {expr}} calls cli_format() automatically on the value of expr, before styling and collapsing it.

cli_format(x, style = NULL, ...)

# S3 method for default
cli_format(x, style = NULL, ...)

# S3 method for character
cli_format(x, style = NULL, ...)

# S3 method for numeric
cli_format(x, style = NULL, ...)

Arguments

x

The object to format.
style

List of formatting options, see the individual methods for the style options they support.
...

Additional arguments for methods.

Details

It is possible to define new S3 methods for cli_format and then these will be used automatically for {.val ...} expressions.

See also

cli_vec()

Examples

things <- c(rep("this", 3), "that")
cli_format(things)

#> [1] "\"this\"" "\"this\"" "\"this\"" "\"that\""
cli_text("{.val {things}}")

#> "this", "this", "this", and "that"

nums <- 1:5 / 7
cli_format(nums, style = list(digits = 2))

#> [1] 0.14 0.29 0.43 0.57 0.71
cli_text("{.val {nums}}")

#> 0.142857142857143, 0.285714285714286, 0.428571428571429, 0.571428571428571, and
#> 0.714285714285714
divid <- cli_div(theme = list(.val = list(digits = 3)))
cli_text("{.val {nums}}")

#> 0.142857142857143, 0.285714285714286, 0.428571428571429, 0.571428571428571, and
#> 0.714285714285714
cli_end(divid)