R: Simplified cli progress messages

cli_progress_message {cli}

R Documentation

Simplified cli progress messages

Description

This is a simplified progress bar, a single (dynamic) message, without progress units.

Usage

cli_progress_message(
  msg,
  current = TRUE,
  .auto_close = TRUE,
  .envir = parent.frame(),
  ...
)

Arguments

`msg`	Message to show. It may contain glue substitution and cli styling. It can be updated via `cli_progress_update()`, as usual.
`current`	Passed to `cli_progress_bar()`.
`.auto_close`	Passed to `cli_progress_bar()`.
`.envir`	Passed to `cli_progress_bar()`.
`...`	Passed to `cli_progress_bar()`.

Details

cli_progress_message() always shows the message, even if no update is due. When the progress message is terminated, it is removed from the screen by default.

Note that the message can be dynamic: if you update it with cli_progress_update(), then cli uses the current values in the string substitutions.

fun <- function() {
  cli_progress_message("Task one is running...")
  Sys.sleep(2)

  cli_progress_message("Task two is running...")
  Sys.sleep(2)

  step <- 1L
  cli_progress_message("Task three is underway: step {step}")
  for (step in 1:5) {
    Sys.sleep(0.5)
    cli_progress_update()
  }
}
fun()

Value