Skip to content

Commit

Permalink
Merge tag '0.14.0' into develop
Browse files Browse the repository at this point in the history
progressr 0.14.0
  • Loading branch information
HenrikBengtsson committed Aug 10, 2023
2 parents 938de99 + a65e447 commit 0dbb50e
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 43 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.13.0-9013
Version: 0.14.0
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(
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ vigns: vignettes/progressr-intro.md

spelling:
$(R_SCRIPT) -e "spelling::spell_check_package()"
$(R_SCRIPT) -e "spelling::spell_check_files(c('NEWS', dir('vignettes', pattern='[.](md|rsp)$$', full.names=TRUE)), ignore=readLines('inst/WORDLIST', warn=FALSE))"
$(R_SCRIPT) -e "spelling::spell_check_files(dir('vignettes', pattern='[.](md|rsp)$$', full.names=TRUE), ignore=readLines('inst/WORDLIST', warn=FALSE))"
4 changes: 2 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Version (development version)
# Version 0.14.0 [2023-08-10]

## New Features

Expand All @@ -8,7 +8,7 @@
is preserved (e.g. a progress bar in the terminal remains), and an
informative message is displayed (if the progress handler supported
it). In previous versions, the preservation of the progress and the
output of the message happend only for interrupts. In this version,
output of the message happened only for interrupts. In this version,
this happens also for errors.

## Miscellaneous
Expand Down
2 changes: 1 addition & 1 deletion R/global_progression_handler.R
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ register_global_progression_handler <- function(action = c("add", "remove", "que

#' A Global Calling Handler For 'progression':s
#'
#' @param progression A [progression] conditions.
#' @param condition A logical scalar or a condition object.
#'
#' @return Nothing.
#'
Expand Down
67 changes: 31 additions & 36 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# CRAN submission progressr 0.13.0
# CRAN submission progressr 0.14.0

on 2023-01-09
on 2023-08-10

I've verified this submission has no negative impact on any of the 70 reverse package dependencies available on CRAN (n = 67) and Bioconductor (n = 3).
I've verified this submission has no negative impact on any of the 82 reverse package dependencies available on CRAN (n = 79) and Bioconductor (n = 3).

Thank you

## Resubmission

Updated version fixing an R CMD check WARNING reported by R-devel on Debian.


## Notes not sent to CRAN

### R CMD check validation

The package has been verified using `R CMD check --as-cran` on:

| R version | GitHub | R-hub | mac/win-builder |
| --------- | ------ | ------ | --------------- |
| 3.5.x | L | | |
| 3.6.x | L | | |
| 4.0.x | L | | |
| 4.1.x | L | M | |
| 4.2.x | L M W | L W | M1 W |
| devel | L M W | L | M1 W |
| R version | GitHub | R-hub | mac/win-builder |
| --------- | ------ | ----- | --------------- |
| 3.5.x | L | | |
| 4.0.x | L | | |
| 4.1.x | L | | |
| 4.2.x | L | | |
| 4.3.x | L M W | L W | M1 W |
| devel | L M W | L | W |

*Legend: OS: L = Linux, M = macOS, M1 = macOS M1, W = Windows*

Expand All @@ -41,48 +45,39 @@ print(res)
gives

```
── progressr 0.13.0: OK
── progressr 0.13.0-9013: OK
Build ID: progressr_0.13.0.tar.gz-d11f185b89e4479482ebfa691044c756
Build ID: progressr_0.13.0-9013.tar.gz-d76d5bc4979b480fa1e4bbe0c5d705a1
Platform: Debian Linux, R-devel, clang, ISO-8859-15 locale
Submitted: 53m 44.4s ago
Build time: 53m 37.5s
Submitted: 17m 26.7s ago
Build time: 17m 23.3s
0 errors ✔ | 0 warnings ✔ | 0 notes ✔
── progressr 0.13.0: OK
── progressr 0.13.0-9013: OK
Build ID: progressr_0.13.0.tar.gz-1edbec52c27c443c9ce9bd4154e92b8c
Build ID: progressr_0.13.0-9013.tar.gz-bbc8cdfc4d0241ebb3d0129420c7fed4
Platform: Debian Linux, R-patched, GCC
Submitted: 53m 44.4s ago
Build time: 53m 10.2s
Submitted: 17m 26.7s ago
Build time: 16m 17.3s
0 errors ✔ | 0 warnings ✔ | 0 notes ✔
── progressr 0.13.0: OK
── progressr 0.13.0-9013: OK
Build ID: progressr_0.13.0.tar.gz-42ae3c8a45a84680a0ea83bfe24bf4e5
Build ID: progressr_0.13.0-9013.tar.gz-71676aa30ce74ff7931c996a95e7b327
Platform: Fedora Linux, R-devel, GCC
Submitted: 53m 44.4s ago
Build time: 46m 26.1s
0 errors ✔ | 0 warnings ✔ | 0 notes ✔
── progressr 0.13.0: OK
Build ID: progressr_0.13.0.tar.gz-eaee37da30424bb5a71d134f77adfb98
Platform: macOS 10.13.6 High Sierra, R-release, CRAN's setup
Submitted: 53m 44.4s ago
Build time: 4m 43.8s
Submitted: 17m 26.7s ago
Build time: 15m 0.3s
0 errors ✔ | 0 warnings ✔ | 0 notes ✔
── progressr 0.13.0: OK
── progressr 0.13.0-9013: OK
Build ID: progressr_0.13.0.tar.gz-95c2a5ae023b4c6793d4e986528cb55d
Build ID: progressr_0.13.0-9013.tar.gz-29b149c623ba4eea91841fd5a9fc6ac7
Platform: Windows Server 2022, R-release, 32/64 bit
Submitted: 53m 44.4s ago
Build time: 4m 19.7s
Submitted: 17m 26.7s ago
Build time: 5m 50.8s
0 errors ✔ | 0 warnings ✔ | 0 notes ✔
```
10 changes: 10 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,13 @@ winprogressbar
withProgress
withProgressShiny
withRestart
cli
happend
imum
pbmclapply
Pushbullet
rpushbullet
RPushbullet
specfied
tidyverse
unhide
2 changes: 1 addition & 1 deletion man/global_progression_handler.Rd

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

2 changes: 2 additions & 0 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ navbar:
href: https://BiocParallel.FutureParam.futureverse.org
- text: future.tools (experimental)
href: https://future.tools.futureverse.org
- text: future.mirai (experimental)
href: https://future.mirai.futureverse.org
- text: future.mapreduce (experimental)
href: https://future.mapreduce.futureverse.org
- text: marshal (experimental)
Expand Down
2 changes: 1 addition & 1 deletion pkgdown/_pkgdown.yml.rsp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<%
pkgs <- c("globals", "listenv", "parallelly", "future", "future.apply", "furrr", "future.tests", "future.callr", "future.batchtools", "doFuture", "progressr")
pkgs_extra <- c("BiocParallel.FutureParam", "future.tools", "future.mapreduce", "marshal")
pkgs_extra <- c("BiocParallel.FutureParam", "future.tools", "future.mirai", "future.mapreduce", "marshal")
pkgs <- c(sort(pkgs), pkgs_extra)
urls <- sprintf("https://%s.futureverse.org", pkgs)
names(urls) <- pkgs
Expand Down

0 comments on commit 0dbb50e

Please sign in to comment.