Skip to contents

Check if a format or alignment is supported

Source: R/format_value.R
check_formats.Rd

Utility functions for checking formats and alignments.

Usage 

is_valid_format(x, stop_otherwise = FALSE)

check_aligns(algn)

Arguments

x

either format string or an object returned by sprintf_format

stop_otherwise

logical, if x is not a format should an error be thrown

algn

vector of characters that indicates the requested cell alignments.

Value

  • is_valid_format: TRUE if x is NULL, a supported format string, or a function; FALSE otherwise.

  • check_aligns: TRUE if it passes the check.

Note

No check if the function is actually a formatter is performed.

Examples 

is_valid_format("xx.x")
#> [1] TRUE
is_valid_format("fakeyfake")
#> [1] FALSE

check_aligns(c("decimal", "dec_right"))