Check Logical — chk_logical • chk

Checks if logical using

is.logical(x)

If you want to check if it is a scalar, meaning that in addition to being of logical type, it has length(x) == 1, you should use chk_lgl()

Usage

chk_logical(x, x_name = NULL)

vld_logical(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_logical(): Validate Logical

See also

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

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

Other data_type_checkers: chk_character(), chk_character_or_factor(), chk_complex(), chk_double(), chk_environment(), chk_integer(), chk_numeric(), chk_raw()

Examples

# chk_logical
chk_logical(TRUE)
try(chk_logical(1))
#> Error in eval(expr, envir) : `1` must be logical.
# vld_logical
vld_logical(TRUE)
#> [1] TRUE
vld_logical(matrix(TRUE))
#> [1] TRUE
vld_logical(logical(0))
#> [1] TRUE
vld_logical(NA)
#> [1] TRUE
vld_logical(1)
#> [1] FALSE
vld_logical("TRUE")
#> [1] FALSE