run() for BatchtoolsFuture now produce an informative BatchtoolsFutureError in case batchtools::submitJobs() fails

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future.batchtools
-Version: 0.10.0-9033
+Version: 0.10.0-9034
 Depends:
     R (>= 3.2.0),
     parallelly,

NEWS.md

@@ -25,6 +25,10 @@
    file (a shell script) with info on location, file size, and number
    of lines, if they exist.
 
+ * `run()` for BatchtoolsFuture now produce an informative
+   BatchtoolsFutureError in case `batchtools::submitJobs()` fails, for
+   instance, due to invalid job-scheduler rsource specifications.
+ 
  * Add BatchtoolsFuture subclasses; abstract
    BatchtoolsUniprocessFuture, abstract BatchtoolsMultiprocessFuture,
    BatchtoolsInteractiveFuture, BatchtoolsLocalFuture,

R/BatchtoolsFuture-class.R

@@ -383,6 +383,7 @@ result.BatchtoolsFuture <- function(future, cleanup = TRUE, ...) {
 
 #' @importFrom future run getExpression
 #' @importFrom batchtools batchExport batchMap saveRegistry setJobNames submitJobs
+#' @importFrom utils capture.output str
 #' @export
 run.BatchtoolsFuture <- function(future, ...) {
   if (future$state != "created") {
@@ -517,8 +518,19 @@ run.BatchtoolsFuture <- function(future, ...) {
 
   ## WORKAROUND: batchtools::submitJobs() updates the RNG state,
   ## which we must make sure to undo.
-  with_stealth_rng({
-    submitJobs(reg = reg, ids = jobid, resources = resources)
+  tryCatch({
+    with_stealth_rng({
+      submitJobs(reg = reg, ids = jobid, resources = resources)
+    })
+  }, error = function(ex) {
+    msg <- conditionMessage(ex)
+    label <- future$label
+    if (is.null(label)) label <- "<none>"
+    msg <- sprintf("Failed to submit %s (%s). The reason was: %s", class(future)[1], label, msg)
+    info <- capture.output(str(resources))
+    info <- paste(info, collapse = "\n")
+    msg <- sprintf("%s\nTROUBLESHOOTING INFORMATION:\nbatchtools::submitJobs() was called with the following 'resources' argument:\n%s\n", msg, info)
+    stop(BatchtoolsFutureError(msg, future = future))
   })
 
   mdebugf("Launched future #%d", jobid$job.id)