check_bool: Check if Argument is Single TRUE or FALSE

View source: R/cli.R

check_boolR Documentation

Check if Argument is Single TRUE or FALSE

Description

Check if an argument is single TRUE or FALSE. As an option it is possible to allow NULL value when alt_null = TRUE.

Usage

check_bool(x, alt_null = FALSE, add_msg = NULL)

Arguments

x

Function argument that is being asserted.

alt_null

Logical. Should argument accept NULL value.

add_msg

Is an additional message that can be printed over the standard function error message. You can:

  • pass the names of the arguments that failed the test by using {x_name} in the message body (e.g. "What are the {x_name}");

  • pass the class of the arguments that failed the test by using {wrong_class} in the message body (e.g. "{wrong_class} is wrong")

Value

If argument is single TRUE or FALSE (optionally NULL) it returns invisible NULL. Otherwise the function throws an error.


cloudfs documentation built on May 29, 2024, 11:08 a.m.