Skip to contents

Check FALSE

Source: R/chk-false.R
chk_false.Rd

Check if FALSE using

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

Usage

chk_false(x, x_name = NULL)

vld_false(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_false(): Validate FALSE

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

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

Examples

# chk_false
chk_false(FALSE)
try(chk_false(0))
#> Error in eval(expr, envir) : `0` must be FALSE.
# vld_false
vld_false(TRUE)
#> [1] FALSE
vld_false(FALSE)
#> [1] TRUE
vld_false(NA)
#> [1] FALSE
vld_false(0)
#> [1] FALSE
vld_false(c(FALSE, FALSE))
#> [1] FALSE