Unlimited learning, half price | 50% off

Last chance! 50% off unlimited learning

Sale ends in


⚠️There's a newer version (0.15.1) of this package.Take me there.

progressr (version 0.10.0)

An Inclusive, Unifying API for Progress Updates

Description

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.

Copy Link

Version

Install

install.packages('progressr')

Monthly Downloads

201,041

Version

0.10.0

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Last Published

December 19th, 2021

Functions in progressr (0.10.0)

handler_filesize

Progression Handler: Progress Reported as the Size of a File on the File System
progress_aggregator

Aggregate Progression Conditions
handler_ascii_alert

Progression Handler: Progress Reported as ASCII BEL Symbols (Audio or Blink) in the Terminal
progress

Creates and Signals a Progression Condition
handler_txtprogressbar

Progression Handler: Progress Reported as Plain Progress Bars (Text) in the Terminal
handler_pbcol

Progression Handler: Progress Reported as an ANSI Background Color in the Terminal
handler_notifier

Progression Handler: Progress Reported via the Operating-System Notification Framework (GUI, Text)
handler_tkprogressbar

Progression Handler: Progress Reported as a Tcl/Tk Progress Bars in the GUI
handler_beepr

Progression Handler: Progress Reported as 'beepr' Sounds (Audio)
handler_debug

Progression Handler: Progress Reported as Debug Information (Text) in the Terminal
progressr.options

Options and environment variables used by the 'progressr' packages
progressor

Create a Progressor Function that Signals Progress Updates
progressr

progressr: A Unifying API for Progress Updates
register_global_progression_handler

Add or Remove a Global 'progression' Handler
handlers

Control How Progress is Reported
handler_progress

Progression Handler: Progress Reported via 'progress' Progress Bars (Text) in the Terminal
make_progression_handler

Creates a Progression Calling Handler
progression

A Progression Condition
progress_progressr

Use Progressr with Plyr Map-Reduce Functions
handler_rstudio

Progression Handler: Progress Reported in the RStudio Console
handler_shiny

Progression Handler: Progress Reported via 'shiny' Widgets (GUI) in the HTML Browser
slow_sum

Slowly Calculate Sum of Elements
withProgressShiny

Use Progressr in Shiny Apps: Plug-in Backward Compatibility Replacement for shiny::withProgress()
with_progress

Report on Progress while Evaluating an R Expression
handler_void

Progression Handler: No Progress Report
handler_winprogressbar

Progression Handler: Progress Reported as a MS Windows Progress Bars in the GUI
handler_newline

Progression Handler: Progress Reported as a New Line (Text) in the Terminal
handler_pbmcapply

Progression Handler: Progress Reported via 'pbmcapply' Progress Bars (Text) in the Terminal
global_progression_handler

A Global Calling Handler For 'progression':s