pb_start: Start a Progress Bar

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

Start a Progress Bar

Description

Start a cli_progress_bar or Progress-based progress bar.

Usage

pb_start(
  name = "Daily Update",
  status = NULL,
  type = c("iterator", "tasks", "download", "custom")[1],
  total = NA,
  is_shiny = FALSE,
  e = rlang::caller_env(),
  ...
)

Arguments

name	(character) Name of the progress bar.
status	(character) Status message for the progress bar.
type	(character) Type of the progress bar. One of "iterator", "tasks", "download", or "custom".
total	(numeric) max for Progress & total for cli_progress_bar.
is_shiny	(logical) Whether running in a shiny environment.
e	The environment in which to start the progress bar.
...	Additional arguments passed to either Progress$new or cli_progress_bar.

Value

An object of class Progress if is_shiny is TRUE, otherwise a cli_progress_bar object.

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