cli_progress_message: Simplified cli progress messages

In RonMobile/cli: Helpers for Developing Command Line Interfaces

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.

Value

The id of the new progress bar.

See Also

cli_progress_bar() for the complete progress bar API. cli_progress_step() for a similar display that is styled by default.

RonMobile/cli documentation built on Dec. 18, 2021, 11 a.m.