progressr 0.5.0

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: progressr
-Version: 0.4.0-9000
+Version: 0.5.0
 Title: A 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 APIs 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(

NEWS

@@ -1,7 +1,7 @@
 Package: progressr
 ==================
 
-Version: 0.4.0-9000 [2020-04-06]
+Version: 0.5.0 [2020-04-16]
 
 NEW FEATURES:
 

cran-comments.md

@@ -1,57 +1,27 @@
-# CRAN submission progressr 0.4.0
+# CRAN submission progressr 0.5.0
 
-on 2020-01-22
+on 2020-04-16
 
-This a first submission.  I've verified that it passed 'R CMD check --as-cran' on Linux, macOS, Solaris, and Windows, on R 3.5.3, R 3.6.2, and R devel.
+I've verified that this submission does not cause issues for the 5 reverse package dependency available on CRAN and Bioconductor.
 
 Thanks in advance
 
 
 ## Notes not sent to CRAN
 
-### R CMD check --as-cran validation
+### R CMD check validation
 
 The package has been verified using `R CMD check --as-cran` on:
 
-* Platform x86_64-apple-darwin15.6.0 (64-bit) [Travis CI]:
-  - R version 3.5.3 (2019-03-11)
-  - R version 3.6.2 (2019-12-12)
-
-* Platform x86_64-unknown-linux-gnu (64-bit) [Travis CI]:
-  - R version 3.5.3 (2017-01-27) [sic!]
-  - R version 3.6.2 (2017-01-27) [sic!]
-  - R Under development (unstable) (2020-01-22 r77696)
-
-* Platform x86_64-pc-linux-gnu (64-bit):
-  - R version 3.6.2 (2019-12-12)
-
-* Platform x86_64-pc-linux-gnu (64-bit) [r-hub]:
-  - R version 3.6.1 (2019-07-05)
-  - R Under development (unstable) (2020-01-18 r77674)
-
-* Platform i686-pc-linux-gnu (32-bit):
-  - R version 3.4.4 (2018-03-15)
-
-* Platform i386-pc-solaris2.10 (32-bit) [r-hub]:
-  - R version 3.6.0 (2019-04-26)
-
-* Platform x86_64-w64-mingw32 (64-bit) [r-hub]:
-  - R Under development (unstable) (2020-01-07 r77637)
-
-* Platform i386-w64-mingw32 (32-bit) [Appveyor CI]:
-  - R version 3.6.2 (2019-12-12)
-  - R Under development (unstable) (2020-01-21 r77688)
-
-* Platform x86_64-w64-mingw32/x64 (64-bit) [Appveyor CI]:
-  - R Under development (unstable) (2020-01-21 r77688)
-
-* Platform x86_64-w64-mingw32/x64 (64-bit) [win-builder]:
-  - R version 3.6.2 (2019-12-12)
-
-
-# Not available
-
-* Platform x86_64-w64-mingw32/x64 (64-bit) [win-builder]:
-  - R Under development (unstable) (2020-01-07 r77633)
-  - REASON: Too many other packages in the queue.
-    
+| R version          | GitHub Actions | Travis CI | AppVeyor CI | Rhub      | Win-builder | Other  |
+| ------------------ | -------------- | --------- | ----------- | --------- | ----------- | ------ |
+| 3.2.5              | L              |           |             |           |             |        |
+| 3.3.3              | L              |           |             |           |             |        |
+| 3.4.4              | L              |           |             |           |             |        |
+| 3.5.3              | L, M, W        | L, M      |             |           |             |        |
+| 3.6.{1,2,3}        | L, M, W        | L, M      | W           | L         | W           |        |
+| 4.0.0-devel        |                |           |             |       W   |             |        |
+| 4.0.0-{alpha,beta} |                |           |             |           | W           | L      |
+| devel              |    M  W        | L         | W (32 & 64) | L         |             |        |
+
+*Legend: OS: L = Linux, S = Solaris, M = macOS, W = Windows.  Architecture: 32 = 32-bit, 64 = 64-bit*

vignettes/progressr-intro.md

@@ -7,12 +7,12 @@
 %\VignetteKeyword{Renviron}
 %\VignetteEngine{progressr::selfonly}
 <!-- DO NOT EDIT THIS FILE! Edit 'OVERVIEW.md' instead and then rebuild this file with 'make vigs' -->
-![Life cycle: experimental](imgs/lifecycle-experimental-orange.svg)
+![Life cycle: experimental](inst/doc/imgs/lifecycle-experimental-orange.svg)
 
 The **[progressr]** package provides a minimal API for reporting progress updates in [R](https://www.r-project.org/).  The design is to separate the representation of progress updates from how they are presented.  What type of progress to signal is controlled by the developer.  How these progress updates are rendered is controlled by the end user.  For instance, some users may prefer visual feedback such as a horizontal progress bar in the terminal, whereas others may prefer auditory feedback.
 
 
-<img src="imgs/three_in_chinese.gif" alt="Three strokes writing three in Chinese" style="float: right; margin-right: 1ex; margin-left: 1ex;"/>
+<img src="inst/doc/imgs/three_in_chinese.gif" alt="Three strokes writing three in Chinese" style="float: right; margin-right: 1ex; margin-left: 1ex;"/>
 
 Design motto:
 
@@ -112,6 +112,16 @@ handlers("txtprogressbar", "beepr")
 ```
 
 
+### Silence all progress
+
+To silence all progress updates, use:
+
+```r
+handlers("void")
+```
+
+
+
 ## Support for progressr elsewhere
 
 Note that progression updates by **progressr** is designed to work out of the box for any _sequential_ iterator framework in R.  Below is an set of examples for the most common ones.
@@ -300,7 +310,7 @@ When using the **progressr** package, progression updates are communicated via R
 
 
 
-![](imgs/slow_sum.svg)
+![](inst/doc/imgs/slow_sum.svg)
 
 _Figure: Sequence diagram illustrating how signaled progression conditions are captured by `with_progress()` and relayed to the two progression handlers 'progress' (a progress bar in the terminal) and 'beepr' (auditory) that the end user has chosen._
 
@@ -328,7 +338,7 @@ To debug progress updates, use:
 
 
 
-[progressr]: https://github.com/HenrikBengtsson/progressr/
+[progressr]: https://cran.r-project.org/package=progressr
 [beepr]: https://cran.r-project.org/package=beepr
 [progress]: https://cran.r-project.org/package=progress
 [purrr]: https://cran.r-project.org/package=purrr