checkmate (version 1.7.3)

checkFlag: Check if an argument is a flag

Description

A flag is defined as single logical value.

Usage

checkFlag(x, na.ok = FALSE)
assertFlag(x, na.ok = FALSE, add = NULL, .var.name = NULL)
assert_flag(x, na.ok = FALSE, add = NULL, .var.name = NULL)
testFlag(x, na.ok = FALSE)
test_flag(x, na.ok = FALSE)
expect_flag(x, na.ok = FALSE, info = NULL, label = NULL)

Arguments

x

[any] Object to check.

na.ok

[logical(1)] Are missing values allowed? Default is FALSE.

add

[AssertCollection] Collection to store assertions. See AssertCollection.

.var.name

[NULL || character(1)] Name of the checked object to print in error message. If NULL, the name will be heuristically determined via substitute.

info

[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.

label

[character(1)] Same as .var.name, but passed down to expect_that.

Value

• Depending on the function prefix: If the check is successful, the functions return TRUE. If the check is not successful, assertFlag/assert_flag throws an error message, testFlag/test_flag returns FALSE, and checkFlag returns a string with the error message. The function expect_flag always returns an expectation.

Details

This function does not distinguish between NA, NA_integer_, NA_real_, NA_complex_ NA_character_ and NaN.

See Also

Other scalars: checkCount, checkInt, checkNumber, checkScalarNA, checkScalar, checkString

Examples

testFlag(TRUE)
testFlag(1)