chk_true: Check TRUE

In chk: Check User-Supplied Function Arguments

Check TRUE

Description

Checks if TRUE using

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

Usage

chk_true(x, x_name = NULL)

vld_true(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_true(): Validate TRUE

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

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

Examples

# chk_true
chk_true(TRUE)
try(chk_true(1))
# vld_true
vld_true(TRUE)
vld_true(FALSE)
vld_true(NA)
vld_true(0)
vld_true(c(TRUE, TRUE))

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