Add timeout <runtime> ... to the default batchtools_bash template script

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future.batchtools
-Version: 0.12.2-9917
+Version: 0.12.2-9918
 Depends:
     R (>= 3.2.0),
     parallelly,

NEWS.md

@@ -13,7 +13,13 @@
 
  * Canceling batchtools futures will now interrupt them by default,
    if the backend supports it.
-   
+
+## Documentation
+
+ * Add `timeout <runtime> ...` to the default `batchtools_bash`
+   template script to illustrate how to control this runtime via the
+   backend `resources` argument.
+
 
 # Version 0.12.2 [2025-06-06]
 

R/batchtools_bash.R

@@ -38,8 +38,8 @@ BatchtoolsBashFutureBackend <- function(...,
 #'
 #' @details
 #' Batchtools bash futures uses \pkg{batchtools} cluster functions
-#' created by [makeClusterFunctionsBash()] and requires that Bash is
-#' installed on the current machine.
+#' created by [makeClusterFunctionsBash()] and requires that `bash' is
+#' installed on the current machine and the `timeout` command is available.
 #'
 #' The default template script `templates/bash.tmpl` can be found in:
 #'
@@ -52,7 +52,8 @@ BatchtoolsBashFutureBackend <- function(...,
 #' `r paste(c("\x60\x60\x60bash", readLines("inst/templates/bash.tmpl"), "\x60\x60\x60"), collapse = "\n")`
 #'
 #' @examplesIf interactive()
-#' plan(batchtools_bash)
+#' # Limit runtime to 30 seconds per future
+#' plan(batchtools_bash, resources = list(runtime = 30))
 #'
 #' message("Main process ID: ", Sys.getpid())
 #'

inst/templates/bash.tmpl

@@ -3,5 +3,12 @@
 # A batchtools launch script template
 ######################################################################
 
+## Maximum runtime?
+<%
+## The default maximum runtime is one hours
+runtime <- resources[["runtime"]]
+if (is.null(runtime)) runtime <- 3600
+%>
+
 # Launch R and evaluate the batchtools R job
-Rscript -e 'batchtools::doJobCollection("<%= uri %>", output = "<%= log.file %>")'
+timeout <%= runtime %> Rscript -e 'batchtools::doJobCollection("<%= uri %>", output = "<%= log.file %>")'