check_optional_logical_scalar: Check optional logical scalar

View source: R/check.R

check_optional_logical_scalarR Documentation

Check optional logical scalar

Description

Check optional logical scalar

Usage

check_optional_logical_scalar(x, arg_name = deparse(substitute(x)))

Arguments

x

Optional Logical: Value to check. Must be NULL or a single non-NA TRUE or FALSE.

arg_name

Character: Argument name to use in error messages.

Value

Called for side effects. Throws an error if checks fail.

Author(s)

EDG

Examples

check_optional_logical_scalar(NULL)
check_optional_logical_scalar(FALSE)
# Throw error:
try(check_optional_logical_scalar(NA))

rtemis.core documentation built on Sept. 20, 2026, 9:06 a.m.