chk_logical: Check Logical

In chk: Check User-Supplied Function Arguments

Check Logical

Description

Checks if logical using

is.logical(x)

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

Other chk_typeof: chk_character_or_factor(), chk_character(), chk_count(), chk_double(), chk_environment(), chk_factor(), chk_integer(), chk_list()

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")

chk documentation built on Oct. 6, 2023, 9:06 a.m.