Package: progressr 0.14.0

progressr: An Inclusive, Unifying API for Progress Updates

A minimal, unifying API for scripts and packages to report progress updates from anywhere including when using parallel processing. The package is designed such that the developer can to focus on what progress should be reported on without having to worry about how to present it. The end user has full control of how, where, and when to render these progress updates, e.g. in the terminal using utils::txtProgressBar(), cli::cli_progress_bar(), in a graphical user interface using utils::winProgressBar(), tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beepr::beep(), or on a file system via the size of a file. Anyone can add additional, customized, progression handlers. The 'progressr' package uses R's condition framework for signaling progress updated. Because of this, progress can be reported from almost anywhere in R, e.g. from classical for and while loops, from map-reduce API:s like the lapply() family of functions, 'purrr', 'plyr', and 'foreach'. It will also work with parallel processing via the 'future' framework, e.g. future.apply::future_lapply(), furrr::future_map(), and 'foreach' with 'doFuture'. The package is compatible with Shiny applications.

Authors:Henrik Bengtsson [aut, cre, cph]

progressr_0.14.0.tar.gz
progressr_0.14.0.zip(r-4.5)progressr_0.14.0.zip(r-4.4)progressr_0.14.0.zip(r-4.3)
progressr_0.14.0.tgz(r-4.4-any)progressr_0.14.0.tgz(r-4.3-any)
progressr_0.14.0.tar.gz(r-4.5-noble)progressr_0.14.0.tar.gz(r-4.4-noble)
progressr_0.14.0.tgz(r-4.4-emscripten)progressr_0.14.0.tgz(r-4.3-emscripten)
progressr.pdf |progressr.html✨
progressr/json (API)
NEWS

# Install 'progressr' in R:
install.packages('progressr', repos = c('https://henrikbengtsson.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/henrikbengtsson/progressr/issues

On CRAN:

conditionsprogress

28 exports 279 stars 11.43 score 1 dependencies 667 dependents 768 scripts 116.2k downloads

Last updated 1 years agofrom:a65e4477bf (on master). Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 04 2024
R-4.5-winOKSep 04 2024
R-4.5-linuxOKSep 04 2024
R-4.4-winOKSep 04 2024
R-4.4-macOKSep 04 2024
R-4.3-winOKSep 04 2024
R-4.3-macOKSep 04 2024

Exports:handler_ascii_alerthandler_beeprhandler_clihandler_debughandler_filesizehandler_newlinehandler_notifierhandler_pbcolhandler_pbmcapplyhandler_progresshandler_rpushbullethandler_rstudiohandler_shinyhandler_tkprogressbarhandler_txtprogressbarhandler_voidhandler_winprogressbarhandlersmake_progression_handlerprogressprogress_aggregatorprogress_progressrprogressionprogressorslow_sumwith_progresswithout_progresswithProgressShiny

Dependencies:digest

progressr: An Introduction

Rendered fromprogressr-intro.mdusingprogressr::selfonlyon Sep 04 2024.

Last update: 2023-08-10
Started: 2020-01-23

Readme and manuals

Help Manual

Help pageTopics
Progression Handler: Progress Reported as ASCII BEL Symbols (Audio or Blink) in the Terminalhandler_ascii_alert
Progression Handler: Progress Reported as 'beepr' Sounds (Audio)handler_beepr
Progression Handler: Progress Reported via 'cli' Progress Bars (Text) in the Terminalhandler_cli
Progression Handler: Progress Reported as Debug Information (Text) in the Terminalhandler_debug
Progression Handler: Progress Reported as the Size of a File on the File Systemhandler_filesize
Progression Handler: Progress Reported as an ANSI Background Color in the Terminalhandler_pbcol
Progression Handler: Progress Reported via 'pbmcapply' Progress Bars (Text) in the Terminalhandler_pbmcapply
Progression Handler: Progress Reported via 'progress' Progress Bars (Text) in the Terminalhandler_progress
Progression Handler: Progress Reported in the RStudio Consolehandler_rstudio
Progression Handler: Progress Reported as a Tcl/Tk Progress Bars in the GUIhandler_tkprogressbar
Progression Handler: Progress Reported as Plain Progress Bars (Text) in the Terminalhandler_txtprogressbar
Progression Handler: No Progress Reporthandler_void
Progression Handler: Progress Reported as a MS Windows Progress Bars in the GUIhandler_winprogressbar
Control How Progress is Reportedhandlers
Use Progressr with Plyr Map-Reduce Functionsprogress_progressr
Create a Progressor Function that Signals Progress Updatesprogressor
progressr: A Unifying API for Progress Updatesprogressr-package progressr
Options and environment variables used by the 'progressr' packagesprogressr.clear progressr.debug progressr.delay_conditions progressr.delay_stdout progressr.demo.delay progressr.enable progressr.enable_after progressr.handlers progressr.interrupts progressr.interval progressr.intrusiveness progressr.intrusiveness.audio progressr.intrusiveness.debug progressr.intrusiveness.file progressr.intrusiveness.gui progressr.intrusiveness.notifier progressr.intrusiveness.terminal progressr.options progressr.times
Report on Progress while Evaluating an R Expressionwithout_progress with_progress
Use Progressr in Shiny Apps: Plug-in Backward-Compatible Replacement for shiny::withProgress()withProgressShiny