checkmate (version 2.3.2)

checkTRUE: Check if an argument is TRUE

Description

Simply checks if an argument is TRUE.

Usage

checkTRUE(x, na.ok = FALSE)
check_true(x, na.ok = FALSE)
assertTRUE(x, na.ok = FALSE, .var.name = vname(x), add = NULL)
assert_true(x, na.ok = FALSE, .var.name = vname(x), add = NULL)
testTRUE(x, na.ok = FALSE)
test_true(x, na.ok = FALSE)

Value

Depending on the function prefix: If the check is successful, the functions

assertTRUE./assert_true. return

x invisibly, whereas

checkTRUE./check_true. and

testTRUE./test_true. return

TRUE. If the check is not successful,

assertTRUE./assert_true.

throws an error message,

testTRUE./test_true.

returns FALSE, and checkTRUE./check_true.

return a string with the error message. The function expect_true. always returns an

expectation.

Arguments

x

[any]
Object to check.

na.ok

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

.var.name

[character(1)]
Name of the checked object to print in assertions. Defaults to the heuristic implemented in vname.

add

[AssertCollection]
Collection to store assertion messages. See AssertCollection.

Examples

testTRUE(TRUE)
testTRUE(FALSE)