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.

Version: 0.15.1
Depends: R (≥ 3.5.0)
Imports: digest, utils
Suggests: graphics, tcltk, beepr, cli, crayon, pbmcapply, progress, purrr, foreach, plyr, doFuture, future, future.apply, furrr, ntfy, RPushbullet, rstudioapi, shiny, commonmark, base64enc, tools
Published: 2024-11-22
DOI: 10.32614/CRAN.package.progressr
Author: Henrik Bengtsson ORCID iD [aut, cre, cph]
Maintainer: Henrik Bengtsson <henrikb at braju.com>
BugReports: https://github.com/futureverse/progressr/issues
License: GPL (≥ 3)
URL: https://progressr.futureverse.org, https://github.com/futureverse/progressr
NeedsCompilation: no
Materials: NEWS
CRAN checks: progressr results

Documentation:

Reference manual: progressr.pdf
Vignettes: progressr: An Introduction (source)

Downloads:

Package source: progressr_0.15.1.tar.gz
Windows binaries: r-devel: progressr_0.15.1.zip, r-release: progressr_0.15.1.zip, r-oldrel: progressr_0.15.1.zip
macOS binaries: r-release (arm64): progressr_0.15.1.tgz, r-oldrel (arm64): progressr_0.15.1.tgz, r-release (x86_64): progressr_0.15.1.tgz, r-oldrel (x86_64): progressr_0.15.1.tgz
Old sources: progressr archive

Reverse dependencies:

Reverse imports: adestr, AIPW, ale, antaresEditObject, ao, basksim, bayesmove, beer, bolasso, calmr, campsis, canaper, cccrm, collinear, crumble, cSEM, cyclestreets, dapper, deseats, dipsaus, drugdevelopR, easyalluvial, ecic, econet, EFAtools, EGAnet, elevatr, EpiForsk, epwshiftr, fabletools, fastRhockey, fdacluster, funGp, futureverse, fxTWAPLS, geocausal, geocmeans, GeoModels, gtfs2gps, hbamr, hoopR, JANE, kmeRtone, lava, lightr, lmtp, LWFBrook90R, mcmcensemble, metasnf, modeltime.resample, nflfastR, nflseedR, nlrx, opentripplanner, parseRPDR, pavo, polle, poppr, powRICLPM, PWIR, rainette, rangeMapper, readsdr, receptiviti, rechaRge, remiod, restriktor, saeczi, Seurat, SeuratObject, simaerep, SimDesign, skpr, smoots, squat, stppSim, targeted, tidyfit, tidySEM, tsdistributions, tsgarch, vital, vmeasur, WARDEN, wehoop, WeightedCluster, ycevo
Reverse suggests: AlpsNMR, baseballr, baskexact, bbotk, EpiModel, EpiNow2, gtfs2emis, hgwrr, hmer, ISAnalytics, mapme.biodiversity, mikropml, mlr3, mpathsenser, nflreadr, oddsapiR, plnr, RAINBOWR, rsi, semPower, sentopics, sims, sphunif, survex, terrainr

Linking:

Please use the canonical form https://CRAN.R-project.org/package=progressr to link to this page.