is_if_condition: Is suitable to be used as an if condition

In assertive.code: Assertions to Check Properties of Code

Is suitable to be used as an if condition

Description

Is suitable to be used as an if condition

Usage

assert_is_if_condition(x, severity = getOption("assertive.severity", "stop"))

is_if_condition(x, .xname = get_name_in_parent(x))

Arguments

x	Input to check.
severity	How severe should the consequences of the assertion be? Either "stop", "warning", "message", or "none".
.xname	Not intended to be used directly.

Value

is_if_condition returns TRUE if the input is scalar TRUE or FALSE.

Note

if will try to do the right thing if you pass it a number or a string, but this function assumes you want to do the right thing and pass either TRUE or FALSE, maybe with some attributes.

Examples

is_if_condition(TRUE)
is_if_condition(FALSE)
is_if_condition(NA)
is_if_condition(c(TRUE, FALSE))
is_if_condition("the truth")
# You can pass a number as a logical condition, but you shouldn't,
# so the next line returns FALSE.
is_if_condition(1)
assertive.base::dont_stop(assert_is_if_condition(raw(1)))

assertive.code documentation built on May 31, 2023, 5:35 p.m.