Check Flag — chk_flag • chk

Checks if non-missing logical scalar using

is.logical(x) && length(x) == 1L && !anyNA(x)

Pass: TRUE, FALSE.

Fail: logical(0), c(TRUE, TRUE), "TRUE", 1, NA.

Do not confuse this function with chk_lgl(), which also checks for logical scalars of length(x) == 1 but can include NAs.

Usage

chk_flag(x, x_name = NULL)

vld_flag(x)

Arguments

x: The object to check.
x_name: A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails or returns the original object if successful so it can used in pipes.

The vld_ function returns a flag indicating whether the test was met.

Functions

vld_flag(): Validate Flag

See also

is.logical() length()

For more details about the use of this function, please read the article vignette("chk-families").

Other logical_checkers: chk_false(), chk_lgl(), chk_logical(), chk_true()

Other scalar_checkers: chk_count(), chk_date(), chk_date_time(), chk_false(), chk_lgl(), chk_scalar(), chk_string(), chk_true(), chk_tz()

Examples

# chk_flag
chk_flag(TRUE)
try(vld_flag(1))
#> [1] FALSE
# vld_flag
vld_flag(TRUE)
#> [1] TRUE
vld_flag(1)
#> [1] FALSE