cli_progress_step {cli} | R Documentation |
This is a simplified progress bar, a single (dynamic) message, without progress units.
cli_progress_step(
msg,
msg_done = msg,
msg_failed = msg,
spinner = FALSE,
class = if (!spinner) ".alert-info",
current = TRUE,
.auto_close = TRUE,
.envir = parent.frame(),
...
)
msg |
Message to show. It may contain glue substitution and cli
styling. It can be updated via |
msg_done |
Message to show on successful termination. By default
this it is the same as |
msg_failed |
Message to show on unsuccessful termination. By
default it is the same as |
spinner |
Whether to show a spinner at the beginning of the line.
To make the spinner spin, you'll need to call |
class |
cli class to add to the message. By default there is no class for steps with a spinner. |
current |
Passed to |
.auto_close |
Passed to |
.envir |
Passed to |
... |
Passed to |
cli_progress_step()
always shows the progress message,
even if no update is due.
f <- function() { cli_progress_step("Downloading data") Sys.sleep(2) cli_progress_step("Importing data") Sys.sleep(1) cli_progress_step("Cleaning data") Sys.sleep(2) cli_progress_step("Fitting model") Sys.sleep(3) } f()
You can add a spinner to some or all steps with spinner = TRUE
,
but not that this will only work if you call cli_progress_update()
regularly.
f <- function() { cli_progress_step("Downloading data", spinner = TRUE) for (i in 1:100) { Sys.sleep(2/100); cli_progress_update() } cli_progress_step("Importing data") Sys.sleep(1) cli_progress_step("Cleaning data") Sys.sleep(2) cli_progress_step("Fitting model", spinner = TRUE) for (i in 1:100) { Sys.sleep(3/100); cli_progress_update() } } f()
You can make the step messages dynamic, using glue templates.
Since cli_progress_step()
show that message immediately, we need
to initialize msg
first.
f <- function() { msg <- "" cli_progress_step("Downloading data{msg}", spinner = TRUE) for (i in 1:100) { Sys.sleep(2/100) msg <- glue::glue(", got file {i}/100") cli_progress_update() } cli_progress_step("Importing data") Sys.sleep(1) cli_progress_step("Cleaning data") Sys.sleep(2) cli_progress_step("Fitting model", spinner = TRUE) for (i in 1:100) { Sys.sleep(3/100); cli_progress_update() } } f()
You can specify a different message for successful and/or unsuccessful termination:
f <- function() { size <- 0L cli_progress_step( "Downloading data.", msg_done = "Downloaded {prettyunits::pretty_bytes(size)}.", spinner = TRUE ) for (i in 1:100) { Sys.sleep(3/100) size <- size + 8192 cli_progress_update() } } f()