CLEANUP: Remove unused functions

Author: HenrikBengtsson

.github/workflows/future_tests.yaml

@@ -17,6 +17,7 @@ jobs:
       matrix:
         future:
           - { plan: 'future.batchtools::batchtools_local' }
+          - { plan: 'future.batchtools::batchtools_bash' }
 
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

Makefile

@@ -4,9 +4,12 @@ spelling:
 	$(R_SCRIPT) -e "spelling::spell_check_files(c('NEWS', dir('vignettes', pattern='[.]rsp', full.names=TRUE)), ignore=readLines('inst/WORDLIST', warn=FALSE))"
 
 future.tests/%:
-	$(R_SCRIPT) -e "future.tests::check" --args --test-plan=$*
+	$(R_SCRIPT) -e "future.tests::check" --args --test-plan="future.batchtools::$*"
 
-future.tests: future.tests/future.batchtools\:\:batchtools_local
+## batchtools_interactive is not 100% compliant (fails test 21. futureCall())
+future.tests: \
+  future.tests/batchtools_local \
+  future.tests/batchtools_bash
 
 spelling:
 	$(R_SCRIPT) -e "spelling::spell_check_package()"

NAMESPACE

@@ -3,14 +3,14 @@
 S3method(add_finalizer,BatchtoolsFuture)
 S3method(delete,BatchtoolsFuture)
 S3method(launchFuture,BatchtoolsFutureBackend)
-S3method(listFutures,BatchtoolsSequentialFutureBackend)
+S3method(listFutures,BatchtoolsUniprocessFutureBackend)
 S3method(loggedError,BatchtoolsFuture)
 S3method(loggedOutput,BatchtoolsFuture)
-S3method(nbrOfFreeWorkers,BatchtoolsSequentialFutureBackend)
+S3method(nbrOfFreeWorkers,BatchtoolsUniprocessFutureBackend)
 S3method(nbrOfFreeWorkers,batchtools)
 S3method(nbrOfFreeWorkers,batchtools_multiprocess)
 S3method(nbrOfFreeWorkers,batchtools_uniprocess)
-S3method(nbrOfWorkers,BatchtoolsSequentialFutureBackend)
+S3method(nbrOfWorkers,BatchtoolsUniprocessFutureBackend)
 S3method(nbrOfWorkers,batchtools)
 S3method(nbrOfWorkers,batchtools_multicore)
 S3method(nbrOfWorkers,batchtools_uniprocess)
@@ -34,9 +34,7 @@ export(BatchtoolsCustomFuture)
 export(BatchtoolsFuture)
 export(BatchtoolsFutureBackend)
 export(BatchtoolsFutureError)
-export(BatchtoolsInteractiveFuture)
 export(BatchtoolsInteractiveFutureBackend)
-export(BatchtoolsLocalFuture)
 export(BatchtoolsLocalFutureBackend)
 export(BatchtoolsLsfFuture)
 export(BatchtoolsMulticoreFuture)
@@ -47,7 +45,6 @@ export(BatchtoolsSSHFuture)
 export(BatchtoolsSlurmFuture)
 export(BatchtoolsTemplateFuture)
 export(BatchtoolsTorqueFuture)
-export(BatchtoolsUniprocessFuture)
 export(batchtools_bash)
 export(batchtools_custom)
 export(batchtools_interactive)

R/BatchtoolsUniprocessFuture-class.R

@@ -12,13 +12,14 @@ BatchtoolsBashFutureBackend <- function(..., template = "bash", cluster.function
   )
 
   core[["futureClasses"]] <- c("BatchtoolsBashFuture", core[["futureClasses"]])
-  core <- structure(core, class = c("BatchtoolsBashFutureBackend", "BatchtoolsSequentialFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
+  core <- structure(core, class = c("BatchtoolsBashFutureBackend", "BatchtoolsUniprocessFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
   core
 }
 
 
 #' @inheritParams batchtools_custom
 #' @inheritParams batchtools_template
+#' @param \ldots Additional arguments passed to [future::future()].
 #'
 #' @export
 batchtools_bash <- function(..., envir = parent.frame(), template = "bash") {

R/backend_api-BatchtoolsBashFutureBackend.R

@@ -9,12 +9,13 @@ BatchtoolsInteractiveFutureBackend <- function(..., cluster.functions = NULL) {
   )
 
   core[["futureClasses"]] <- c("BatchtoolsInteractiveFuture", core[["futureClasses"]])
-  core <- structure(core, class = c("BatchtoolsInteractiveFutureBackend", "BatchtoolsSequentialFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
+  core <- structure(core, class = c("BatchtoolsInteractiveFutureBackend", "BatchtoolsUniprocessFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
   core
 }
 
 
-#' @inheritParams BatchtoolsUniprocessFuture
+#' @inheritParams BatchtoolsFuture
+#' @param \ldots Additional arguments passed to [future::future()].
 #'
 #' @importFrom batchtools makeClusterFunctionsInteractive
 #' @export

R/backend_api-BatchtoolsInteractiveFutureBackend.R

@@ -1,3 +1,5 @@
+#' @param \ldots Additional arguments passed to [BatchtoolsFutureBackend()].
+#'
 #' @rdname BatchtoolsFutureBackend
 #' @importFrom batchtools makeClusterFunctionsInteractive
 #' @export
@@ -9,7 +11,7 @@ BatchtoolsLocalFutureBackend <- function(..., cluster.functions = NULL) {
   )
 
   core[["futureClasses"]] <- c("BatchtoolsLocalFuture", core[["futureClasses"]])
-  core <- structure(core, class = c("BatchtoolsLocalFutureBackend", "BatchtoolsSequentialFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
+  core <- structure(core, class = c("BatchtoolsLocalFutureBackend", "BatchtoolsUniprocessFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
   core
 }
 
@@ -23,11 +25,12 @@ BatchtoolsLocalFutureBackend <- function(..., cluster.functions = NULL) {
 #' be assigned to the calling environment rather than to a local one).
 #' Both types of futures will block until the futures are resolved.
 #'
-#' @inheritParams BatchtoolsUniprocessFuture
-#' 
-#' @param \ldots Additional arguments passed to [BatchtoolsUniprocessFuture()].
+#' @inheritParams BatchtoolsFuture
+#' @inheritParams BatchtoolsLocalFutureBackend
+#'
+#' @param \ldots Additional arguments passed to [future::future()].
 #'
-#' @return An object of class `BatchtoolsUniprocessFuture`.
+#' @return An object of class `BatchtoolsFuture`.
 #'
 #' @details
 #' batchtools local futures rely on the batchtools backend set up by

R/backend_api-BatchtoolsLocalFutureBackend.R

@@ -1,19 +1,19 @@
 #' @export
-nbrOfWorkers.BatchtoolsSequentialFutureBackend <- function(evaluator) {
+nbrOfWorkers.BatchtoolsUniprocessFutureBackend <- function(evaluator) {
   1L
 }
 
 
 #' @export
-nbrOfFreeWorkers.BatchtoolsSequentialFutureBackend <- function(evaluator, background = FALSE, ...) {
+nbrOfFreeWorkers.BatchtoolsUniprocessFutureBackend <- function(evaluator, background = FALSE, ...) {
   assert_no_positional_args_but_first()
   if (isTRUE(background)) 0L else 1L
 }
 
 
 #' @importFrom future listFutures
 #' @export
-listFutures.BatchtoolsSequentialFutureBackend <- function(backend, ...) {
+listFutures.BatchtoolsUniprocessFutureBackend <- function(backend, ...) {
   data.frame(
     counter = integer(0L),
     start = proc.time()[[3]][integer(0L)],