toolExpectLessDiff: toolExpectLessDiff

In pik-piam/mstools: Tool functions that can be used by several madrat-dependent or magpie4 output functions

toolExpectLessDiff

Description

tool function for status reporting. It performs a difference check between two objects and returns either a message via toolStatusMessage, that the test was successful or that it failed.

Usage

toolExpectLessDiff(x, y, maxdiff, description, level = 0, maxdiff2 = NULL)

Arguments

x	object 1
y	object 2 which has the same format as object 1
maxdiff	allowed maximum difference per element between x and y.
description	a description of the check
level	as the test result will be linked to a function call, the function needs to know to which call it should be linked. by default (level = 0) the parent function call is being used. Increasing the number by one will let the function go up by one in the call stack, level = -1 will use toolExpectTrue itself as function call.
maxdiff2	optional additional threshold. If set it will serve as a second, critial threshold which will throw a warning (instead of a simple note in case of maxdiff) if being surpassed.

Author(s)

Jan Philipp Dietrich

See Also

getMadratMessage, toolExpectTrue, toolStatusMessage

Examples

toolExpectLessDiff(1:3, 2:4, 10, "data is sufficiently close", level = -1)
getMadratMessage("status")

pik-piam/mstools documentation built on Dec. 8, 2024, 5:29 a.m.