chk (version 0.10.0)

chk_logical: Check Logical

Description

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)

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.

Arguments

x

The object to check.

x_name

A string of the name of object x or NULL.

Functions

• vld_logical(): Validate Logical

See Also

is.logical()

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))
# vld_logical
vld_logical(TRUE)
vld_logical(matrix(TRUE))
vld_logical(logical(0))
vld_logical(NA)
vld_logical(1)
vld_logical("TRUE")