Show a progress message when executing a stagerunner.
show_message(stage_names, stage_index, begin = TRUE, nested = FALSE, depth = 1)
stage_names | character. |
---|---|
stage_index | integer. |
begin | logical. Whether we are showing the begin or end message. |
nested | logical. Whether or not this is a nested stage (i.e. contains another stageRunner). |
depth | integer. How many tabs to space by (for nested stages). |
Nothing, but print the message to standard output.
not_run({ show_message(c('one', 'two'), 2) # Will print "Beginning one stage..." })