AssertCollection: Collect multiple assertions

In checkmate: Fast and Versatile Argument Checks

Collect multiple assertions

Description

The function makeAssertCollection() returns a simple stack-like closure you can pass to all functions of the assert*-family. All messages get collected and can be reported with reportAssertions(). Alternatively, you can easily write your own report function or customize the the output of the report function to a certain degree. See the example on how to push custom messages or retrieve all stored messages.

Usage

makeAssertCollection()

reportAssertions(collection)

Arguments

collection

[AssertCollection] Object of type “AssertCollection” (constructed via makeAssertCollection).

Value

makeAssertCollection() returns an object of class “AssertCollection” and reportCollection returns invisibly TRUE if no error is thrown (i.e., no message was collected).

Examples

x = "a"
coll = makeAssertCollection()

print(coll$isEmpty())
assertNumeric(x, add = coll)
coll$isEmpty()
coll$push("Custom error message")
coll$getMessages()
## Not run: 
  reportAssertions(coll)

## End(Not run)

checkmate documentation built on Sept. 11, 2024, 8:40 p.m.