pb_update.Progress: S3 Progress Method pb_update

View source: R/daily_update_utils.R

pb_update.ProgressR Documentation

S3 Progress Method pb_update

Description

Update a Progress object with a new message, increment, or set value.

Usage

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

Arguments

pbar

Progress object 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. Typically used for passing "detail".

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.