help tweaks

Author: HenrikBengtsson

DESCRIPTION

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

R/batchtools_lsf.R

@@ -20,8 +20,9 @@ BatchtoolsLsfFutureBackend <- function(...) {
 #' @details
 #' Batchtools Load Sharing Facility (LSF) futures use \pkg{batchtools}
 #' cluster functions created by [batchtools::makeClusterFunctionsLSF()],
-#' which requires that LSF commands `bsub`, `bjobs`, and `bkill` are
-#' installed on the current machine.
+#' which are used to interact with the LSF job scheduler. This requires
+#' that LSF commands `bsub`, `bjobs`, and `bkill` are available on the
+#' current machine.
 #'
 #' The default template script `templates/lsf.tmpl` can be found in:
 #'

R/batchtools_openlava.R

@@ -19,9 +19,10 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 #'
 #' @details
 #' Batchtools OpenLava futures use \pkg{batchtools} cluster functions
-#' created by [batchtools::makeClusterFunctionsOpenLava()], which requires
-#' that OpenLava commands `sbatch`, `squeue`, and `scancel` are installed on
-#' the current machine.
+#' created by [batchtools::makeClusterFunctionsOpenLava()], which are used
+#' to interact with the OpenLava job scheduler. This requires that OpenLava
+#' commands `bsub`, `bjobs`, and `bkill` are available on the current
+#' machine.
 #'
 #' The default template script `templates/openlava.tmpl` can be found in:
 #'

R/batchtools_sge.R

@@ -27,9 +27,10 @@ print.BatchtoolsSGEFutureBackend <- function(x, ...) {
 #'
 #' @details
 #' Batchtools SGE futures use \pkg{batchtools} cluster functions
-#' created by [batchtools::makeClusterFunctionsSGE()], which requires
-#' that SGE commands `qsub`, `qstat`, and `qdel` are installed on
-#' the current machine.
+#' created by [batchtools::makeClusterFunctionsSGE()], which are used
+#' to interact with the SGE job scheduler. This requires that SGE
+#' commands `qsub`, `qstat`, and `qdel` are available on the current
+#' machine.
 #'
 #' The default template script `templates/sge.tmpl` can be found in:
 #'

R/batchtools_slurm.R

@@ -28,9 +28,10 @@ print.BatchtoolsSlurmFutureBackend <- function(x, ...) {
 #'
 #' @details
 #' Batchtools slurm futures use \pkg{batchtools} cluster functions
-#' created by [batchtools::makeClusterFunctionsSlurm()], which requires
-#' that Slurm commands `sbatch`, `squeue`, and `scancel` are installed on
-#' the current machine.
+#' created by [batchtools::makeClusterFunctionsSlurm()], which are used
+#' to interact with the Slurm job scheduler. This requires that Slurm
+#' commands `sbatch`, `squeue`, and `scancel` are available on the current
+#' machine.
 #'
 #' The default template script `templates/slurm.tmpl` can be found in:
 #'

R/batchtools_torque.R

@@ -17,9 +17,10 @@ BatchtoolsTorqueFutureBackend <- function(...) {
 #' @param \ldots Not used.
 #'
 #' @details
-#' Batchtools torque futures use \pkg{batchtools} cluster functions
-#' created by [batchtools::makeClusterFunctionsTORQUE()], which requires
-#' that TORQUE commands `qsub`, `qselect`, and `qdel` are installed on
+#' Batchtools TORQUE/PBS futures use \pkg{batchtools} cluster functions
+#' created by [batchtools::makeClusterFunctionsTORQUE()], which are used
+#' to interact with the TORQUE/PBS job scheduler. This requires that
+#' TORQUE/PBS commands `qsub`, `qselect`, and `qdel` are available on
 #' the current machine.
 #'
 #' The default template script `templates/torque.tmpl` can be found in: