check_lgl: Check Flag

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check Flag

Description

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

Usage

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)
check_lgl(FALSE, error = FALSE)
check_lgl(c(FALSE, TRUE), error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.