toolstartmessage: Tool: Start message

Description Usage Arguments Value Author(s) See Also Examples

View source: R/toolstartmessage.R

Description

Function writes a process start message and performs some diagnostics

Usage

1
toolstartmessage(argumentValues, level = NULL)

Arguments

argumentValues

list of the evaluated arguments of the calling function

level

This argument allows to establish a hierarchy of print statements. The hierarchy is preserved for the next vcat executions. Currently this setting can have 4 states: NULL (nothing will be changed), 0 (reset hierarchies), "+" (increase hierarchy level by 1) and "-" (decrease hierarchy level by 1).

Value

a list containing diagnostic information required by toolendmessage

Author(s)

Jan Philipp Dietrich, Pascal Führlich

See Also

toolendmessage, vcat

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
innerFunction <- function() {
  startinfo <- madrat:::toolstartmessage(list(argumentsToPrint = 123), "+")
  vcat(1, "inner")
  madrat:::toolendmessage(startinfo, "-")
}
outerFunction <- function() {
  startinfo <- madrat:::toolstartmessage(list(), "+")
  vcat(1, "outer")
  innerFunction()
  madrat:::toolendmessage(startinfo, "-")
}
outerFunction()

madrat documentation built on Oct. 11, 2021, 9:10 a.m.