chk_lgl: Check Logical Scalar

In chk: Check User-Supplied Function Arguments

Check Logical Scalar

Description

Checks if logical scalar using

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

If you only want to check the data type (not whether length(x) == 1), you should use the chk_logical() function.

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

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_flag(), chk_logical(), chk_true()

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

Examples

# chk_lgl
chk_lgl(NA)
try(chk_lgl(1))
# vld_lgl
vld_lgl(TRUE)
vld_lgl(FALSE)
vld_lgl(NA)
vld_lgl(1)
vld_lgl(c(TRUE, TRUE))

chk documentation built on April 3, 2025, 8:50 p.m.