Help tweaks

Author: HenrikBengtsson

DESCRIPTION

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

R/BatchtoolsTemplateFutureBackend-class.R

@@ -15,6 +15,11 @@
 #'
 #' @param \ldots Additional arguments passed to [BatchtoolsFutureBackend()].
 #'
+#' @param workers The maximum number of workers the batchtools backend may
+#' use at any time, which for HPC schedulers corresponds to the maximum number
+#' of queued jobs. The default is
+#' \code{getOption("\link{future.batchtools.workers}", 100)}.
+#'
 #' @return An object of class `BatchtoolsFutureBackend`.
 #'
 #' @details

R/batchtools_lsf.R

@@ -9,7 +9,6 @@ BatchtoolsLsfFutureBackend <- function(...) {
 
 #' A batchtools LSF backend resolves futures in parallel via a Load Sharing Facility (LSF) job scheduler
 #'
-#' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsTemplateFutureBackend
 #'
 #' @param template (optional) Name of job-script template to be searched

R/batchtools_multicore.R

@@ -24,7 +24,6 @@
 #' The batchtools multicore backend only works on operating systems
 #' supporting the `ps` command-line tool, e.g. Linux and macOS.
 #'
-#' @rdname BatchtoolsFutureBackend
 #' @keywords internal
 #'
 #' @aliases batchtools_custom
@@ -73,7 +72,6 @@ BatchtoolsMulticoreFutureBackend <- function(workers = availableCores(constraint
 
 #' A batchtools backend that resolves futures in parallel via forked background R processes
 #'
-#' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsMulticoreFutureBackend
 #'
 #' @param \ldots Not used.

R/batchtools_openlava.R

@@ -9,7 +9,6 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 
 #' A batchtools openlava backend resolves futures in parallel via a OpenLava job scheduler
 #'
-#' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsTemplateFutureBackend
 #'
 #' @param template (optional) Name of job-script template to be searched

R/batchtools_sge.R

@@ -8,7 +8,6 @@ BatchtoolsSGEFutureBackend <- function(...) {
 
 #' A batchtools SGE backend resolves futures in parallel via a SGE job scheduler
 #'
-#' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsTemplateFutureBackend
 #'
 #' @param template (optional) Name of job-script template to be searched

R/batchtools_slurm.R

@@ -9,7 +9,6 @@ BatchtoolsSlurmFutureBackend <- function(...) {
 
 #' A batchtools slurm backend resolves futures in parallel via a Slurm job scheduler
 #'
-#' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsTemplateFutureBackend
 #'
 #' @param template (optional) Name of job-script template to be searched

R/batchtools_torque.R

@@ -8,7 +8,6 @@ BatchtoolsTorqueFutureBackend <- function(...) {
 
 #' A batchtools TORQUE backend resolves futures in parallel via a TORQUE/PBS job scheduler
 #'
-#' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsTemplateFutureBackend
 #'
 #' @param template (optional) Name of job-script template to be searched