assert_logical: Assert input is logical
In assertions: Simple Assertions for Beautiful and Customisable Error Messages

assert_logical

R Documentation

Assert input is logical

Description

Assert an R object is 'logical' (TRUE/FALSE). Works for vector and matrix objects. To assert an object is specifically a logical vector see assert_logical_vector()

Usage

assert_logical(x, msg = NULL, call = rlang::caller_env(), arg_name = NULL)

Arguments

`x`	An object
`msg`	A character string containing the error message to display if `x` is not logical
`call`	Only relevant when pooling assertions into multi-assertion helper functions. See cli_abort for details.
`arg_name`	Advanced use only. Name of the argument passed (default: NULL, will automatically extract arg_name).

Value

invisible(TRUE) if x is logical, otherwise aborts with the error message specified by msg

Examples

try({
assert_logical(TRUE) # Passes
assert_logical(c(TRUE, FALSE, TRUE)) # Passes
assert_logical(c("a", "b")) # Throws default error
assert_logical(1:3, "Custom error message") # Throws custom error
})

assertions documentation built on April 3, 2025, 5:52 p.m.