cli_status_update: Update the status bar (superseded)

In cli: Helpers for Developing Command Line Interfaces

Update the status bar (superseded)

Description

The ⁠cli_status_*()⁠ functions are superseded by the cli_progress_message() and cli_progress_step() functions, because they have a better default behavior.

Update the status bar

Usage

cli_status_update(
  id = NULL,
  msg = NULL,
  msg_done = NULL,
  msg_failed = NULL,
  .envir = parent.frame()
)

Arguments

id	Id of the status bar to update. Defaults to the current status bar container.
msg	Text to update the status bar with. NULL if you don't want to change it.
msg_done	Updated "done" message. NULL if you don't want to change it.
msg_failed	Updated "failed" message. NULL if you don't want to change it.
.envir	Environment to evaluate the glue expressions in.

Value

Id of the status bar container.

See Also

This function supports inline markup.

The cli_progress_message() and cli_progress_step() functions, for a superior API.

Other status bar: cli_process_start(), cli_status_clear(), cli_status()

Other functions supporting inline markup: cli_abort(), cli_alert(), cli_blockquote(), cli_bullets_raw(), cli_bullets(), cli_dl(), cli_h1(), cli_li(), cli_ol(), cli_process_start(), cli_progress_along(), cli_progress_bar(), cli_progress_message(), cli_progress_output(), cli_progress_step(), cli_rule, cli_status(), cli_text(), cli_ul(), format_error(), format_inline()

cli documentation built on June 22, 2024, 10:57 a.m.