processCheck: processCheck

In IAMconsortium/iamc: IAMC Tools

processCheck

Description

Processes a check, which means that it returns a note if the check fails, returns a check summary based on the chosen verbosity and returns the check results in a structured way. All checks should be run within processCheck. Requirement for a check function is that it returns a list with 2 elements: "message" which contains the standard message that should show up for the test and "failed" which is a vector of names for which the corresponding test failed.

Usage

processCheck(check, input)

Arguments

check	Function call as character that should be run
input	Named list with elements available for check functions

Value

List containing check results

Author(s)

Jan Philipp Dietrich

See Also

iamProjectConfig, as.quitte, is.quitte

Examples

out <- processCheck(check = "checkMin(x, cfg)",
                  input = list(x=example_REMIND, cfg=iamProjectConfig()))

IAMconsortium/iamc documentation built on July 8, 2023, 11:35 p.m.