pb_update.character: S3 character Method pb_update

In COHHIO/Rm_data: Data munging dependencies for Rminor & Rminor_elevated Shiny apps

S3 character Method pb_update

Description

Update a cli_progress_bar object with a new message, increment, or set value when the progress bar is referenced by its ID.

Usage

## S3 method for class 'character'
pb_update(
  pbar,
  message = NULL,
  inc = NULL,
  set = NULL,
  ...,
  e = rlang::caller_env()
)

Arguments

pbar	(character) ID of the progress bar to be updated.
message	(character) New message to display with the progress bar.
inc	(numeric) Amount to increment the progress bar by.
set	(numeric) Value to set the progress bar to.
...	Additional arguments passed to the progress bar's update method.
e	The environment from which to evaluate the function.

Value

None. This function is called for its side effects.

COHHIO/Rm_data documentation built on Dec. 9, 2024, 2:10 p.m.