Merge branch 'release/0.6.0'

Author: HenrikBengtsson

.Rbuildignore

@@ -61,3 +61,4 @@ Rplots.pdf$
 ^last.dump*
 ^imgs
 ^.*.bob$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -12,23 +12,26 @@ jobs:
       fail-fast: false
       matrix:
         config:
-        - { os: windows-latest, r: '3.5'}
-        - { os: windows-latest, r: '3.6'}
-        - { os: windows-latest, r: 'devel'}
-        - { os: macOS-latest, r: '3.5'}
-        - { os: macOS-latest, r: '3.6'}
-        - { os: macOS-latest, r: 'devel'}
-        - { os: ubuntu-16.04, r: '3.4', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
-        - { os: ubuntu-16.04, r: '3.5', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
-        - { os: ubuntu-16.04, r: '3.6', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
+          - { os: windows-latest, r: '3.5'}
+          - { os: windows-latest, r: '3.6'}
+          - { os: windows-latest, r: '4.0'}
+          - { os: windows-latest, r: 'devel'}
+          - { os: macOS-latest, r: '3.5'}
+          - { os: macOS-latest, r: '3.6'}
+          - { os: macOS-latest, r: '4.0'}
+          - { os: macOS-latest, r: 'devel'}
+          - { os: ubuntu-16.04, r: '3.4', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
+          - { os: ubuntu-16.04, r: '3.5', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
+          - { os: ubuntu-16.04, r: '3.6', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
+          - { os: ubuntu-16.04, r: '4.0', cran: "https://demo.rstudiopm.com/all/__linux__/xenial/latest"}
 
     env:
       R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
       CRAN: ${{ matrix.config.cran }}
 
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - uses: r-lib/actions/setup-r@master
         with:
@@ -37,14 +40,18 @@ jobs:
       - uses: r-lib/actions/setup-pandoc@master
 
       - name: Query dependencies
-        run: Rscript -e "install.packages('remotes')" -e "saveRDS(remotes::dev_package_deps(dependencies = TRUE), 'depends.Rds', version = 2)"
+        run: |
+          install.packages('remotes')
+          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
+          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
+        shell: Rscript {0}
 
       - name: Cache R packages
         if: runner.os != 'Windows'
         uses: actions/cache@v1
         with:
           path: ${{ env.R_LIBS_USER }}
-          key: ${{ runner.os }}-r-${{ matrix.config.r }}-${{ hashFiles('depends.Rds') }}
+          key: ${{ runner.os }}-r-${{ matrix.config.r }}-${{ hashFiles('.github/depends.Rds') }}
           restore-keys: ${{ runner.os }}-r-${{ matrix.config.r }}-
 
       - name: Install system dependencies
@@ -58,11 +65,21 @@ jobs:
 
       - name: Install dependencies
         run: |
-          Rscript -e "library(remotes)" -e "update(readRDS('depends.Rds'))" -e "remotes::install_cran('rcmdcheck')"
-          Rscript -e "install.packages('progressr')"  ## 'self' vignette engine
+          remotes::install_deps(dependencies = TRUE)
+          remotes::install_cran("rcmdcheck")
+          install.packages("progressr")  ## 'self' vignette engine
+        shell: Rscript {0}
 
+      - name: Session info
+        run: |
+          options(width = 100)
+          pkgs <- installed.packages()[, "Package"]
+          sessioninfo::session_info(pkgs, include_base = TRUE)
+        shell: Rscript {0}
+        
       - name: Check
-        run: Rscript -e "rcmdcheck::rcmdcheck(args = '--no-manual', error_on = 'warning', check_dir = 'check')"
+        run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
+        shell: Rscript {0}
 
       - name: Upload check results
         if: failure()

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: progressr
-Version: 0.5.0
+Version: 0.6.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,6 +1,57 @@
 Package: progressr
 ==================
 
+Version: 0.6.0 [2020-05-18]
+
+SIGNIFICANT CHANGES:
+
+ * Now with_progress() makes sure that any output produced while reporting on
+   progress will not interfer with the progress output and vice versa, which
+   otherwise is a common problem with progress frameworks that output to the
+   terminal, e.g. progress-bar output output is interweaved with printed
+   objects.  In contrast, when using 'progressr' we can use message() and
+   print() as usual regardless of progress being reported or not.
+
+NEW FEATURES:
+
+ * Signaling progress(msg, class = "sticky") will cause the message to be
+   sticky, e.g. for progress bars outputting to the terminal, the message
+   will be "pushed" above the progress bar.
+
+ * with_progress() gained argument 'delay_terminal' whose default will be
+   automatically inferred from inspecting the currently set handlers and
+   whether they output to the terminal or not.
+
+ * Arguments 'delay_stdout' and 'delay_conditions' for with_progress() is
+   now agile to the effective value of the 'delay_terminal' argument.
+
+ * Now handler_nnn() functions pass additional arguments in '...' to the
+   underlying progress-handler backend, e.g. handler_progress(width = 40L)
+   will set up progress::progress_bar$new(width = 40L).
+ 
+ * Add environment variables 'R_PROGRESSR_CLEAR', 'R_PROGRESSR_ENABLE',
+   'R_PROGRESSR_ENABLE_AFTER', 'R_PROGRESSR_TIMES', and 'R_PROGRESSR_INTERVAL'
+   for controlling the default value of the corresponding 'progressr.*' options.
+ 
+BUG FIXES:
+
+ * Limiting the frequency of progress reporting via handler arguments 'times',
+   'interval' or 'intrusivness' did not work and was effectively ignored.
+   
+ * The 'progress' handler, which uses progress::progress_bar(), did not support
+   colorization of the 'format' string when done by the 'crayon' package.
+
+ * handlers() did not return invisible (as documented).
+
+ * Argument 'target' was ignored for all handler functions.
+
+ * Argument 'interval' was ignored for handler_debug().
+
+ * The class of handler_nnn() functions where all "reset_progression_handler"
+   rather than "nnn_progression_handler".  The same bug caused the reported
+   'name' field to be "reset" rather than "nnn".
+ 
+
 Version: 0.5.0 [2020-04-16]
 
 NEW FEATURES: