Merge branch 'release/0.1.1'

Author: HenrikBengtsson

.Rbuildignore

@@ -51,12 +51,6 @@ Rplots.pdf$
 ^[.]docs/
 ^.*[.]png
 
-#----------------------------
-# Package specific
-#----------------------------
-^[.]BatchJobs[.]R$
-[.]future
-
 #----------------------------
 # Miscellaneous
 #----------------------------

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

@@ -1,12 +1,12 @@
 on: [push, pull_request]
-
+  
 name: R-CMD-check
 
 jobs:
   R-CMD-check:
     if: "! contains(github.event.head_commit.message, '[ci skip]')"    
 
-    timeout-minutes: 15
+    timeout-minutes: 30
 
     runs-on: ${{ matrix.config.os }}
 
@@ -16,22 +16,35 @@ jobs:
       fail-fast: false
       matrix:
         config:
-#         - {os: windows-latest, r: 'release' }
-#         - {os: macOS-latest,   r: 'release' }
-          - {os: ubuntu-latest,  r: 'devel'   }
-#         - {os: ubuntu-latest,  r: 'release' }
-
+#          - {os: windows-latest, r: 'release'  }
+#          - {os: windows-latest, r: 'oldrel'   }
+#          - {os: macOS-latest,   r: 'release'  }
+          - {os: ubuntu-latest,  r: 'devel'    }
+          - {os: ubuntu-latest,  r: 'release'  }
+#          - {os: ubuntu-latest,  r: 'oldrel'   }
+#          - {os: ubuntu-latest,  r: '4.1'      }
+ 
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
-      RSPM: https://packagemanager.rstudio.com/cran/__linux__/jammy/latest
+      R_KEEP_PKG_SOURCE: yes
       R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
+      ## Test in other locale (optional)
+      LANGUAGE: ${{ matrix.config.language }}
+      ## R (>= 4.4.0) Note, no trailing underscore (sic!)
+      _R_COMPARE_LANG_OBJECTS: eqonly
       ## R CMD check
       _R_CHECK_CRAN_INCOMING_: false
-      _R_CHECK_LENGTH_1_CONDITION_: true
-      _R_CHECK_LENGTH_1_LOGIC2_: true
       _R_CHECK_MATRIX_DATA_: true
       _R_CHECK_SUGGESTS_ONLY_: true
-
+      _R_CHECK_THINGS_IN_TEMP_DIR_: true
+      _R_CHECK_TESTS_NLINES_: 300
+      RCMDCHECK_ERROR_ON: note
+      ## Specific to futures
+      R_FUTURE_CONNECTIONS_ONMISUSE: "error[details=TRUE]"
+      R_FUTURE_GLOBALENV_ONMISUSE: "error"
+      R_FUTURE_GLOBALS_ONREFERENCE: "warning"
+      R_FUTURE_RNG_ONMISUSE: error
+      
     steps:
       - uses: actions/checkout@v4
 
@@ -40,59 +53,59 @@ jobs:
       - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
-
-      - name: Query R package dependencies
-        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
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+          
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          path: ${{ env.R_LIBS_USER }}
-          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
-          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+          extra-packages: |
+            any::rcmdcheck
+            any::remotes
+          needs: check
 
-      - name: Install R package system dependencies (Linux)
-        if: runner.os == 'Linux'
-        env:
-          RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
+      - name: Install package itself (special case)
         run: |
-          Rscript -e "remotes::install_github('r-hub/sysreqs')"
-          sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
-          sudo -s eval "$sysreqs"
-          sudo apt install -y libcurl4-openssl-dev
-
-      - name: Install R package dependencies
-        run: |
-          remotes::install_deps(dependencies = TRUE)
-          install.packages(".", repos = NULL, type = "source")  ## self vignette engine
-        shell: Rscript {0}
-
-      - name: Install 'rcmdcheck'
-        run: |
-          remotes::install_cran("rcmdcheck")
-          library(rcmdcheck)  ## triggers an error, if installation failed
+          install.packages(".", repos = NULL, type = "source")  ## needed by parallel workers
+          remotes::install_github("futureverse/doFuture", ref = "develop")
+          
         shell: Rscript {0}
 
       - name: Session info
         run: |
           options(width = 100)
+          parallelly::availableCores(which = "all")
+          sapply(c(physical_cores = FALSE, logical_cores = TRUE), parallel::detectCores)
+          if (require(RhpcBLASctl, quietly=TRUE)) c(get_num_procs = get_num_procs(), get_num_cores = get_num_cores(), blas_get_num_procs = blas_get_num_procs(), omp_get_num_procs = omp_get_num_procs(), omp_get_max_threads = omp_get_max_threads())
           capabilities()
           pkgs <- installed.packages()[, "Package"]
           sessioninfo::session_info(pkgs, include_base = TRUE)
+          ## Verify LANGUAGE settings by generating a translatable error
+          cat(sprintf("LANGUAGE=%s\n", sQuote(Sys.getenv("LANGUAGE"))))
+          cat(sprintf("locales: %s\n", sQuote(Sys.getlocale())))
+          tryCatch(log("a"), error = conditionMessage)
         shell: Rscript {0}
 
       - name: Check
-        run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran", if (.Platform$OS.type == "windows" && getRversion() >= "4.2.0") "--no-multiarch"), error_on = "warning", check_dir = "check")
+        if: runner.os != 'Windows'
+        run: |
+          rcmdcheck::rcmdcheck(
+            args = c("--no-manual", "--as-cran"),
+            check_dir = "check"
+          )
+        shell: Rscript {0}
+ 
+      - name: Check (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          rcmdcheck::rcmdcheck(
+            args = c("--no-manual", "--as-cran", if (getRversion() >= "4.2.0") "--no-multiarch"),
+            check_dir = "check"
+          )
         shell: Rscript {0}
 
       - name: Upload check results
         if: failure()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ runner.os }}-r${{ matrix.config.r }}-results
           path: check

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future.tools
-Version: 0.1.0-9002
+Version: 0.1.1
 Title: Tools for Working with Futures
 Depends:
    R (>= 3.3.0),
@@ -18,5 +18,5 @@ LazyLoad: TRUE
 Encoding: UTF-8
 URL: https://future.tools.futureverse.org, https://github.com/futureverse/future.tools
 BugReports: https://github.com/futureverse/future.tools/issues
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.3
 Roxygen: list(markdown = TRUE)

NEWS.md

@@ -1,6 +1,6 @@
-# Version (development version)
+# Version 0.1.1 (2025-10-31)
 
- * ...
+ * Documentation updates.
 
 
 # Version 0.1.0 (2023-05-19)

R/100.journal.R

@@ -3,7 +3,7 @@
 #' _WARNING: This function is under development. It can change at any time.
 #' For now, please, do not depend on this function in a published R package._
 #'
-#' @param x A [Future] object.
+#' @param x A [future::Future] object.
 #'
 ## @param baseline (POSIXct; optional) A timestamp to server as time zero
 ## for the relative start time (`at`). If `TRUE` (default), then the

R/testme.R

@@ -0,0 +1,10 @@
+## This runs 'testme' test inst/testme/test-<name>.R scripts
+## Don't edit - it was autogenerated by inst/testme/deploy.R
+testme <- function(name) {
+  path <- system.file(package = 'future.tools', 'testme', mustWork = TRUE)
+  Sys.setenv(R_TESTME_PATH = path)
+  Sys.setenv(R_TESTME_PACKAGE = 'future.tools')
+  Sys.setenv(R_TESTME_NAME = name)
+  on.exit(Sys.unsetenv('R_TESTME_NAME'))
+  source(file.path(path, 'run.R'))
+}

README.md

@@ -7,8 +7,8 @@
 
 ## Installation
 
-R package **[future.tools]** is available via R-universe and can be
-installed as:
+The **future.tools** package is not, yet, on CRAN. In the meanwhile,
+it can be installed from the R Universe as:
 
 ```r
 options(repos = c("https://futureverse.r-universe.dev", getOption("repos")))
@@ -18,16 +18,11 @@ install.packages("future.tools")
 
 ### Pre-release version
 
-To install the pre-release version that is available in Git branch
-`develop` on [GitHub], use:
-
+To install the pre-release version that is available in Git branch `develop` on GitHub, use:
 ```r
-remotes::install_github("futureverse/future.tools", ref="develop")
+remotes::install_github("futureverse/future.tools", ref = "develop")
 ```
-
 This will install the package from source.  
 
-[future.tools]: https://future.tools.futureverse.org
-[GitHub]: https://www.github.com/futureverse/future.tools
-
 <!-- pkgdown-drop-below -->
+

inst/testme/_epilogue/001.undo-future.R

@@ -0,0 +1,5 @@
+## Undo future debug
+options(future.debug = FALSE)
+
+## Undo future strategy
+future::plan(oplan)

tests/incl/end.R inst/testme/_epilogue/002.undo-state.Rtests/incl/end.R renamed to inst/testme/_epilogue/002.undo-state.R

@@ -1,15 +1,18 @@
-## Undo future strategy
-future::plan(oplan)
-
+testme <- as.environment("testme")
+hpaste <- future:::hpaste
 
 ## Undo options
 ## (a) Reset
 options(oopts0)
+
 ## (b) Remove added
-added <- setdiff(names(options()), names(oopts0))
-opts <- vector("list", length = length(added))
-names(opts) <- added
-options(opts)
+local({
+  added <- setdiff(names(options()), names(oopts0))
+  opts <- vector("list", length = length(added))
+  names(opts) <- added
+  options(opts)
+})
+
 ## (c) Assert that everything was undone
 if (!identical(options(), oopts0)) {
   message("Failed to undo options:")
@@ -22,16 +25,18 @@ if (!identical(options(), oopts0)) {
   missing <- setdiff(names(oopts0), names(oopts))
   message(paste(sprintf(" - Options missing: [n=%d]", length(missing)),
                 hpaste(sQuote(missing))))
-  message("Differences option by option:")                
-  for (name in names(oopts0)) {
+                
+  message("Differences option by option:")
+  void <- lapply(names(oopts0), FUN = function(name) {
     value0 <- oopts0[[name]]
     value  <- oopts[[name]]
     if (!identical(value, value0)) {
-      utils::str(list(name = name, expected = value0, actual = value))
+      if (testme[["debug"]]) {
+        utils::str(list(name = name, expected = value0, actual = value))
+      }
     }
-  }
+  })
 }
-stopifnot(identical(options(), oopts0))
 
 
 ## Undo system environment variables
@@ -53,21 +58,22 @@ if (!identical(Sys.getenv(), oenvs0)) {
   message(paste(sprintf(" - Environment variables missing: [n=%d]", length(missing)),
                 hpaste(sQuote(missing))))
   message("Differences environment variable by environment variable:")
-  for (name in names(oenvs0)) {
+  void <- lapply(names(oenvs0), FUN = function(name) {
     value0 <- unname(oenvs0[name])
     value  <- unname(oenvs[name])
     if (!identical(value, value0)) {
-      utils::str(list(name = name, expected = value0, actual = value))
+      if (testme[["debug"]]) {
+        utils::str(list(name = name, expected = value0, actual = value))
+      }
     }
-  }
+  })
 }
 
 
-## Undo variables
-rm(list = c(setdiff(ls(), ovars)))
-
+## Assert undo was successful
+if (testme[["debug"]]) {
+  stopifnot(identical(options(), oopts0))
+}
 
-## Travis CI specific: Explicit garbage collection because it
-## looks like Travis CI might run out of memory during 'covr'
-## testing and we now have so many tests. /HB 2017-01-11
-if ("covr" %in% loadedNamespaces()) gc()
+## Undo variables
+rm(list = c(setdiff(ls(envir = globalenv()), ovars)), envir = globalenv())

inst/testme/_epilogue/090.gc.R

@@ -0,0 +1,8 @@
+## Travis CI specific: Explicit garbage collection because it
+## looks like Travis CI might run out of memory during 'covr'
+## testing and we now have so many tests. /HB 2017-01-11
+if ("covr" %in% loadedNamespaces()) {
+  res <- gc()
+  testme <- as.environment("testme")
+  if (testme[["debug"]]) print(res)
+}