toolStatusMessage: toolStatusMessage

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

toolStatusMessage

Description

tool to trigger status messages describing the data quality at different stages of processing. Messages are directly written to the log at execution but also collected to be finally returned as data report.

Usage

toolStatusMessage(status, message, level = 0)

Arguments

status	status indicator of the messages. Currently either "ok" (check succesful / quality ok), "note" (check unsuccessful but still acceptable) or "warn" (check unsuccessful / undesired result).
message	message to be triggered.
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.

Author(s)

Jan Philipp Dietrich

See Also

getMadratMessage, toolExpectLessDiff, toolStatusMessage

Examples

toolStatusMessage("ok", "everything is ok", level = -1)
toolStatusMessage("note", "this is not optimal but probably acceptable", level = -1)
toolStatusMessage("warn", "this is not ok", level = -1)
getMadratMessage("status")

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