Check Flag

Source: R/lgl.R

Checks if x is a flag (non-missing logical scalar with no attributes including names).

check_lgl(x, coerce = FALSE, x_name = substitute(x), error = TRUE)

check_flag(x, coerce = FALSE, x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

coerce

A flag indicating whether to drop attributes including names.

x_name

A string of the name of the object x.

error

A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See also

check_scalar

Examples

check_lgl(1, error = FALSE)
#> Warning: `check_lgl()` was deprecated in checkr 0.5.1.
#> Please use `chk::chk_lgl()` instead.
#> Warning: 1 must be class logical
#> Warning: 1 must inherit from classes 'logical' in that order
check_lgl(FALSE, error = FALSE)
#> Warning: `check_lgl()` was deprecated in checkr 0.5.1.
#> Please use `chk::chk_lgl()` instead.
check_lgl(c(FALSE, TRUE), error = FALSE)
#> Warning: `check_lgl()` was deprecated in checkr 0.5.1.
#> Please use `chk::chk_lgl()` instead.
#> Warning: c(FALSE, TRUE) must have 1 element