forked from pik-piam/madrat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
toolstartmessage.Rd
45 lines (42 loc) · 1.51 KB
/
toolstartmessage.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/toolstartmessage.R
\name{toolstartmessage}
\alias{toolstartmessage}
\title{Tool: Start message}
\usage{
toolstartmessage(functionName, argumentValues, level = NULL)
}
\arguments{
\item{functionName}{The name of the calling function as a string.}
\item{argumentValues}{A list of the evaluated arguments of the calling function.}
\item{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 \code{\link{toolendmessage}}.
}
\description{
This function writes a process start message (what function was called with which arguments) and stores the current
time, so the corresponding call to \code{\link{toolendmessage}} can calculate the elapsed time.
}
\examples{
innerFunction <- function() {
startinfo <- madrat:::toolstartmessage("innerFunction", list(argumentsToPrint = 123), "+")
vcat(1, "inner")
madrat:::toolendmessage(startinfo, "-")
}
outerFunction <- function() {
startinfo <- madrat:::toolstartmessage("outerFunction", list(), "+")
vcat(1, "outer")
innerFunction()
madrat:::toolendmessage(startinfo, "-")
}
outerFunction()
}
\seealso{
\code{\link{toolendmessage}}, \code{\link{vcat}}
}
\author{
Jan Philipp Dietrich, Pascal Sauer
}