cli_status_clear

0th

Percentile

Clear the status bar

Clear the status bar

Usage
cli_status_clear(
  id = NULL,
  result = c("clear", "done", "failed"),
  msg_done = NULL,
  msg_failed = NULL,
  .envir = parent.frame()
)
Arguments
id

Id of the status bar container to clear. If id is not the id of the current status bar (because it was overwritten by another status bar container), then the status bar is not cleared. If NULL (the default) then the status bar is always cleared.

result

Whether to show a message for success or failure or just clear the status bar.

msg_done

If not NULL, then the message to use for successful process termination. This overrides the message given when the status bar was created.

msg_failed

If not NULL, then the message to use for failed process termination. This overrides the message give when the status bar was created.

.envir

Environment to evaluate the glue expressions in. It is also used to auto-clear the status bar if .auto_close is `TRUE.

See Also

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

Aliases
  • cli_status_clear
Documentation reproduced from package cli, version 2.0.1, License: MIT + file LICENSE

Community examples

Looks like there are no examples yet.