checkmate (version 1.7.3)

assert: Combine multiple checks into one assertion

Description

You can call this function with an arbitrary number of of check* functions, i.e. functions provided by this package or your own functions which return TRUE on success and the error message as character(1) otherwise. The resulting assertion is successful, if combine is or (default) and at least one check evaluates to TRUE or combine is and and all checks evaluate to TRUE. Otherwise, assert throws an informative error message.

Usage

assert(..., combine = "or", .var.name = NULL)

Arguments

...

[any] List of calls to check functions.

combine

[character(1)] or or and to combine the check functions with an OR or AND, respectively.

.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.

Value

• Throws an error if all checks fail and invisibly returns TRUE otherwise.

Examples

x = 1:10
assert(checkNull(x), checkInteger(x, any.missing = FALSE))
x = 1
assert(checkChoice(x, c("a", "b")), checkDataFrame(x))