HELP: Update all HPC example to (a) request the same resources and (b) to use also the 'asis' specifier

Author: HenrikBengtsson

DESCRIPTION

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

R/batchtools_lsf.R

@@ -36,8 +36,13 @@ BatchtoolsLsfFutureBackend <- function(...) {
 #' @examplesIf interactive()
 #' library(future)
 #'
-#' # Limit runtime to 3 minutes and memory to 200 MiB per future
-#' plan(future.batchtools::batchtools_lsf, resources = list(W = "00:03:00", M = "200"))
+#' # 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.
+#' plan(future.batchtools::batchtools_lsf, resources = list(
+#'   W = "00:10:00", M = "400",
+#'   asis = c("-n 4", "-R 'span[hosts=1]'", "-q freecycle")
+#' ))
 #'
 #' f <- future(Sys.info())
 #' info <- value(f)

R/batchtools_openlava.R

@@ -36,8 +36,13 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 #' @examplesIf interactive()
 #' library(future)
 #'
-#' # Limit runtime to 3 minutes and memory to 200 MiB per future
-#' plan(future.batchtools::batchtools_lsf, resources = list(W = "00:03:00", M = "200"))
+#' # 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.
+#' plan(future.batchtools::batchtools_openlava, resources = list(
+#'   W = "00:10:00", M = "400",
+#'   asis = c("-n 4", "-R 'span[hosts=1]'", "-q freecycle")
+#' ))
 #'
 #' f <- future(Sys.info())
 #' info <- value(f)

R/batchtools_sge.R

@@ -40,11 +40,12 @@ BatchtoolsSGEFutureBackend <- function(...) {
 #' @examplesIf interactive()
 #' library(future)
 #'
-#' # Limit runtime to 3 minutes and memory to 200 MiB per future,
-#' # request two slots and run in the current working directory.
+#' # 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.
 #' plan(future.batchtools::batchtools_sge, resources = list(
-#'   h_rt = "00:03:00", mem_free = "200M",
-#'   asis = c("-pe smp 2", "-cwd")
+#'   h_rt = "00:10:00", mem_free = "100M",  ## memory is per process
+#'   asis = c("-pe smp 4", "-q freecycle.q")
 #' ))
 #'
 #' f <- future(Sys.info())

R/batchtools_slurm.R

@@ -41,8 +41,13 @@ BatchtoolsSlurmFutureBackend <- function(...) {
 #' @examplesIf interactive()
 #' library(future)
 #'
-#' # Limit runtime to 3 minutes and memory to 200 MiB per future
-#' plan(future.batchtools::batchtools_slurm, resources = list(time = "00:03:00", mem = "200M"))
+#' # 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.
+#' plan(future.batchtools::batchtools_slurm, resources = list(
+#'   time = "00:10:00", mem = "400M",
+#'   asis = c("--nodes=1", "-ntasks=4", "--partition=freecycle")
+#' ))
 #'
 #' f <- future(Sys.info())
 #' info <- value(f)

R/batchtools_torque.R

@@ -35,8 +35,13 @@ BatchtoolsTorqueFutureBackend <- function(...) {
 #' @examplesIf interactive()
 #' library(future)
 #'
-#' # Limit runtime to 3 minutes and memory to 200 MiB per future
-#' plan(future.batchtools::batchtools_torque, resources = list(walltime = "00:03:00", mem = "200mb"))
+#' # 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.
+#' 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")
+#' ))
 #'
 #' f <- future(Sys.info())
 #' info <- value(f)