Help examples: clarify resource specifications

Author: HenrikBengtsson

R/batchtools_lsf.R

@@ -38,7 +38,8 @@ BatchtoolsLsfFutureBackend <- function(...) {
 #'
 #' # Limit runtime to 10 minutes and total memory to 400 MiB per future,
 #' # request a parallel environment with four slots on a single host.
-#' # Submit to the 'freecycle' queue.
+#' # Submit to the 'freecycle' queue. Load environment modules 'r' and
+#' # 'jags'. Report on job details at startup and at the end of the job.
 #' plan(future.batchtools::batchtools_lsf, resources = list(
 #'   W = "00:10:00", M = "400",
 #'   asis = c("-n 4", "-R 'span[hosts=1]'", "-q freecycle"),

R/batchtools_openlava.R

@@ -38,7 +38,8 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 #'
 #' # Limit runtime to 10 minutes and total memory to 400 MiB per future,
 #' # request a parallel environment with four slots on a single host.
-#' # Submit to the 'freecycle' queue.
+#' # Submit to the 'freecycle' queue. Load environment modules 'r' and
+#' # 'jags'. Report on job details at startup and at the end of the job.
 #' plan(future.batchtools::batchtools_openlava, resources = list(
 #'   W = "00:10:00", M = "400",
 #'   asis = c("-n 4", "-R 'span[hosts=1]'", "-q freecycle"),

R/batchtools_sge.R

@@ -51,7 +51,8 @@ print.BatchtoolsSGEFutureBackend <- function(x, ...) {
 #'
 #' # Limit runtime to 10 minutes and memory to 400 MiB per future,
 #' # request a parallel environment with four slots on a single host.
-#' # Submit to the 'freecycle' queue.
+#' # Submit to the 'freecycle' queue. Load environment modules 'r' and
+#' # 'jags'. Report on job details at startup and at the end of the job.
 #' plan(future.batchtools::batchtools_sge, resources = list(
 #'   h_rt = "00:10:00", mem_free = "100M",  ## memory is per process
 #'   asis = c("-pe smp 4", "-q freecycle.q"),

R/batchtools_slurm.R

@@ -55,7 +55,8 @@ print.BatchtoolsSlurmFutureBackend <- function(x, ...) {
 #'
 #' # Limit runtime to 10 minutes and memory to 400 MiB per future,
 #' # request a parallel environment with four slots on a single host.
-#' # Submit to the 'freecycle' partition.
+#' # Submit to the 'freecycle' partition. Load environment modules 'r' and
+#' # 'jags'. Report on job details at startup and at the end of the job.
 #' plan(future.batchtools::batchtools_slurm, resources = list(
 #'   time = "00:10:00", mem = "400M",
 #'   asis = c("--nodes=1", "--ntasks=4", "--partition=freecycle"),

R/batchtools_torque.R

@@ -37,7 +37,8 @@ BatchtoolsTorqueFutureBackend <- function(...) {
 #'
 #' # Limit runtime to 10 minutes and total memory to 400 MiB per future,
 #' # request a parallel environment with four slots on a single host.
-#' # Submit to the 'freecycle' queue.
+#' # Submit to the 'freecycle' queue. Load environment modules 'r' and
+#' # 'jags'. Report on job details at startup and at the end of the job.
 #' plan(future.batchtools::batchtools_torque, resources = list(
 #'   walltime = "00:10:00", mem = "100mb",  ## memory is per process
 #'   asis = c("-l nodes=1:ppn=4", "-q freecycle"),