show_message: Show a progress message when executing a stagerunner.

Description Usage Arguments Value Examples

Description

Show a progress message when executing a stagerunner.

Usage

1
2
show_message(stage_names, stage_index, begin = TRUE, nested = FALSE,
  depth = 1)

Arguments

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).

Value

Nothing, but print the message to standard output.

Examples

1
2
3
4
## Not run: 
  show_message(c('one', 'two'), 2) # Will print "Beginning one stage..."

## End(Not run)

syberia/stagerunner documentation built on May 30, 2019, 10:41 p.m.