Skip to content

Commit

Permalink
NEWS: Mention new handler_nfty()
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrikBengtsson committed Oct 28, 2024
1 parent 80e53f1 commit fb18647
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 4 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: progressr
Version: 0.14.0-9009
Version: 0.14.0-9010
Title: 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(), 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@R: c(person("Henrik", "Bengtsson",
Expand Down
8 changes: 7 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Version (development version)

## New Features

* Add `handler_ntfy()` for reporting on progress via the Ntfy.sh
Messaging Service using the **ntfy** package.


## Bug Fixes

* `withProgressShiny()` could produce an `if (config$max_steps ==
Expand Down Expand Up @@ -623,7 +629,7 @@
* TESTS: Increased package test coverage of progression handlers by
running all code except the last step that calls the backend, which
may not be installed or supported on the current platform,
e.g. **tcltk**, **beepr**, notifier.
e.g. **tcltk**, **beepr**, and **notifier**.

## Bug Fixes

Expand Down
8 changes: 6 additions & 2 deletions R/progressr-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,15 @@
#' In Shiny:
#' * [withProgressShiny]
#'
#' Via notification systems:
#' * [handler_ntfy]
#' * [handler_notifier]
#' * [handler_rpushbullet]
#'
#' @example incl/progressr-package.R
#'
#' @keywords programming iteration
#'
#' @docType package
#' @aliases progressr-package
#' @name progressr
NULL
"_PACKAGE"
7 changes: 7 additions & 0 deletions man/progressr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fb18647

Please sign in to comment.