Implement BatchtoolsBashFutureBackend

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future.batchtools
-Version: 0.12.1-9101
+Version: 0.12.1-9102
 Depends:
     R (>= 3.2.0),
     parallelly,

NAMESPACE

@@ -3,14 +3,14 @@
 S3method(add_finalizer,BatchtoolsFuture)
 S3method(delete,BatchtoolsFuture)
 S3method(launchFuture,BatchtoolsFutureBackend)
-S3method(listFutures,BatchtoolsLocalFutureBackend)
+S3method(listFutures,BatchtoolsSequentialFutureBackend)
 S3method(loggedError,BatchtoolsFuture)
 S3method(loggedOutput,BatchtoolsFuture)
-S3method(nbrOfFreeWorkers,BatchtoolsLocalFutureBackend)
+S3method(nbrOfFreeWorkers,BatchtoolsSequentialFutureBackend)
 S3method(nbrOfFreeWorkers,batchtools)
 S3method(nbrOfFreeWorkers,batchtools_multiprocess)
 S3method(nbrOfFreeWorkers,batchtools_uniprocess)
-S3method(nbrOfWorkers,BatchtoolsLocalFutureBackend)
+S3method(nbrOfWorkers,BatchtoolsSequentialFutureBackend)
 S3method(nbrOfWorkers,batchtools)
 S3method(nbrOfWorkers,batchtools_multicore)
 S3method(nbrOfWorkers,batchtools_uniprocess)
@@ -29,6 +29,7 @@ S3method(waitForWorker,BatchtoolsUniprocessFuture)
 S3method(waitForWorker,default)
 export("%resources%")
 export(BatchtoolsBashFuture)
+export(BatchtoolsBashFutureBackend)
 export(BatchtoolsCustomFuture)
 export(BatchtoolsFuture)
 export(BatchtoolsFutureBackend)

R/batchtools_bash.R renamed to R/backend_api-BatchtoolsBashFutureBackend.R

@@ -1,12 +1,28 @@
+#' @param template (optional) A batchtools template file or a template string
+#' (in \pkg{brew} format).  If not specified, it is left to the
+#' \pkg{batchtools} package to locate such file using its search rules.
+#'
+#' @rdname BatchtoolsFutureBackend
+#' @export
+BatchtoolsBashFutureBackend <- function(..., template = "bash", cluster.functions = NULL) {
+  cluster.functions <- makeClusterFunctionsBash(template = template)
+  core <- BatchtoolsFutureBackend(
+    ...,
+    cluster.functions = cluster.functions
+  )
+  
+  core[["futureClasses"]] <- c("BatchtoolsBashFuture", core[["futureClasses"]])
+  core <- structure(core, class = c("BatchtoolsBashFutureBackend", "BatchtoolsSequentialFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
+  core
+}
+
+
 #' @inheritParams batchtools_custom
 #' @inheritParams batchtools_template
 #'
 #' @export
 batchtools_bash <- function(..., envir = parent.frame(), template = "bash") {
-  cf <- makeClusterFunctionsBash(template = template)
-  future <- BatchtoolsBashFuture(..., envir = envir, cluster.functions = cf)
-  if (!future$lazy) future <- run(future)
-  invisible(future)
+  stop("INTERNAL ERROR: The future.batchtools::batchtools_bash() function implements the FutureBackend and should never be called directly")
 }
 class(batchtools_bash) <- c(
   "batchtools_bash", "batchtools_custom",
@@ -15,6 +31,7 @@ class(batchtools_bash) <- c(
 )
 attr(batchtools_bash, "tweakable") <- c("finalize")
 attr(batchtools_bash, "untweakable") <- c("workers")
+attr(batchtools_bash, "factory") <- BatchtoolsBashFutureBackend
 
 
 #' @importFrom batchtools cfReadBrewTemplate cfBrewTemplate makeClusterFunctions makeSubmitJobResult

R/BatchtoolsFutureBackend-class.R renamed to R/backend_api-BatchtoolsFutureBackend-class.R

@@ -1,11 +1,3 @@
-#' Future backends based on the 'batchtools' framework
-#'
-#' @inheritParams future::FutureBackend
-#'
-#' @param \ldots Additional arguments passed to `FutureBackend()`.
-#'
-#' @return An object of class `BatchtoolsFutureBackend`.
-#'
 #' @rdname BatchtoolsFutureBackend
 #' @importFrom batchtools makeClusterFunctionsInteractive
 #' @export
@@ -17,37 +9,11 @@ BatchtoolsLocalFutureBackend <- function(..., cluster.functions = NULL) {
   )
 
   core[["futureClasses"]] <- c("BatchtoolsLocalFuture", core[["futureClasses"]])
-  core <- structure(core, class = c("BatchtoolsLocalFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
+  core <- structure(core, class = c("BatchtoolsLocalFutureBackend", "BatchtoolsSequentialFutureBackend", setdiff(class(core), "MultiprocessFutureBackend")))
   core
 }
 
 
-#' @export
-nbrOfWorkers.BatchtoolsLocalFutureBackend <- function(evaluator) {
-  1L
-}
-
-
-#' @export
-nbrOfFreeWorkers.BatchtoolsLocalFutureBackend <- function(evaluator, background = FALSE, ...) {
-  assert_no_positional_args_but_first()
-  if (isTRUE(background)) 0L else 1L
-}
-
-
-#' @importFrom future listFutures
-#' @export
-listFutures.BatchtoolsLocalFutureBackend <- function(backend, ...) {
-  data.frame(
-    counter = integer(0L),
-    start = proc.time()[[3]][integer(0L)],
-    label = character(0L),
-    resolved = logical(0L),
-    future = list()[integer(0L)]
-  )
-}
-
-
 #' batchtools local and interactive futures
 #'
 #' A batchtools local future is an synchronous uniprocess future that

R/batchtools_local.R renamed to R/backend_api-BatchtoolsLocalFutureBackend.R

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