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() or progress::progress_bar(), in a graphical user interface using utils::winProgressBar(), tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beep::beepr(), 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.

Getting started

Package details

AuthorHenrik Bengtsson [aut, cre, cph]
MaintainerHenrik Bengtsson <henrikb@braju.com>
LicenseGPL (>= 3)
Version0.9.0
URL https://progressr.futureverse.org https://github.com/HenrikBengtsson/progressr
Package repositoryView on CRAN
Installation Install the latest version of this package by entering the following in R:
install.packages("progressr")

Try the progressr package in your browser

Any scripts or data that you put into this service are public.

progressr documentation built on Sept. 24, 2021, 5:07 p.m.