toolstartmessage: Tool: Start message

In madrat: May All Data be Reproducible and Transparent (MADRaT) *

Description

Function writes a process start message and performs some diagnostics

Usage

toolstartmessage(level = NULL)

Arguments

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

See Also

toolendmessage, vcat

Examples

## Not run: 
tmp <- function(bla=NULL) {
  startinfo <- toolstartmessage("+")
  print(bla)
  toolendmessage(startinfo,"-")
  }
tmp(bla=99)

## End(Not run)

madrat documentation built on Dec. 25, 2019, 9:07 a.m.