Check Logical Scalar — chk_lgl • chk

Checks if logical scalar using

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

Usage

chk_lgl(x, x_name = NULL)

vld_lgl(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_lgl(): Validate Logical Scalar

See also

Other chk_logical: chk_false(), chk_flag(), chk_true()

Examples

# chk_lgl
chk_lgl(NA)
try(chk_lgl(1))
#> Error in eval(expr, envir) : 
#>   `1` must be a logical scalar (TRUE, FALSE or NA).
# vld_lgl
vld_lgl(TRUE)
#> [1] TRUE
vld_lgl(FALSE)
#> [1] TRUE
vld_lgl(NA)
#> [1] TRUE
vld_lgl(1)
#> [1] FALSE
vld_lgl(c(TRUE, TRUE))
#> [1] FALSE