assert_is_scalar_logical: Assert is scalar logical

View source: R/scalar-assertions.R

assert_is_scalar_logicalR Documentation

Assert is scalar logical

Description

Raises an assertion error when !rlang::is_scalar_logical(obj).

Usage

assert_is_scalar_logical(
  obj,
  error_message = "{.arg obj} must be a scalar {.cls logical}",
  error_class = NULL
)

Arguments

obj

<any> any value

error_message

<string> a message to be displayed when assertion fails.

error_class

<character> the class name/s for the error.

See Also

Other scalar-assertions: assert_is_bool(), assert_is_scalar_character(), assert_is_scalar_double(), assert_is_scalar_integerish(), assert_is_scalar_integer(), assert_is_scalar_numeric(), assert_is_scalar_raw(), assert_is_string()


qfes/tidyassert documentation built on March 19, 2022, 7:18 a.m.