chk_flag: Check Flag

In chk: Check User-Supplied Function Arguments

Check Flag

Description

Checks if non-missing logical scalar using

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

Pass: TRUE, FALSE.

Fail: logical(0), c(TRUE, TRUE), "TRUE", 1, NA.

Usage

chk_flag(x, x_name = NULL)

vld_flag(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_flag(): Validate Flag

See Also

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

Examples

# chk_flag
chk_flag(TRUE)
try(vld_flag(1))
# vld_flag
vld_flag(TRUE)
vld_flag(1)

chk documentation built on Sept. 11, 2024, 7:34 p.m.