check_logical: Check (supposed) logical values.

View source: R/utils_checks.R

check_logicalR Documentation

Check (supposed) logical values.

Description

Check (supposed) logical values.

Usage

check_logical(..., list_allowed = FALSE, call = NULL)

Arguments

...

Should be a single named argument, where the name is the variable name displayed in the error message. The value is the (supposed) logical.

list_allowed

Logical indicating if the argument is allowed to be a list. If TRUE each element will be checked.

call

Call to use for the call in the error message (used in rlang::abort). Default is rlang::caller_env() resulting in the function that called check_logical().

Value

Error if not logical or longer than 1, otherwise nothing.


ggcorrheatmap documentation built on Aug. 25, 2025, 1:11 a.m.