Add help page for 'batchtools_multicore'

Author: HenrikBengtsson

DESCRIPTION

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

R/batchtools_bash.R

@@ -58,7 +58,7 @@ BatchtoolsBashFutureBackend <- function(...,
 #'
 #' f <- future(Sys.getpid())
 #' pid <- value(f)
-#' message("Workers process ID: ", pid)
+#' message("Worker process ID: ", pid)
 #' 
 #' @export
 batchtools_bash <- function(

R/batchtools_interactive.R

@@ -21,28 +21,29 @@ BatchtoolsInteractiveFutureBackend <- function(...) {
 #' The batchtools interactive backend is useful for verifying parts of your
 #' \pkg{batchtools} setup locally, while still being able to do interactive
 #' debugging.
-#' An alternative to the batchtools interactive backend is to use
-#' `plan(future::sequential)`, which is a faster way process futures
-#' sequentially and that also can be debugged interactively.
 #'
 #' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsInteractiveFutureBackend
 #'
 #' @param \ldots Not used.
 #'
 #' @details
-#' Batchtools interactive futures uses \pkg{batchtools} cluster functions
+#' Batchtools interactive futures use \pkg{batchtools} cluster functions
 #' created by [batchtools::makeClusterFunctionsInteractive()] with
 #' `external = TRUE`.
 #'
+#' An alternative to the batchtools interactive backend is to use
+#' `plan(future::sequential)`, which is a faster way process futures
+#' sequentially and that also can be debugged interactively.
+#'
 #' @examples
 #' plan(batchtools_interactive)
 #'
 #' message("Main process ID: ", Sys.getpid())
 #'
 #' f <- future(Sys.getpid())
 #' pid <- value(f)
-#' message("Workers process ID: ", pid)
+#' message("Worker process ID: ", pid)
 #' 
 #' @inheritParams BatchtoolsInteractiveFutureBackend
 #'

R/batchtools_local.R

@@ -28,8 +28,6 @@
 #' An alternative to batchtools interactive futures is to use
 #' `plan(sequential, split = TRUE)` futures of the \pkg{future} package.
 #'
-#' @example incl/batchtools_local.R
-#'
 #' @rdname BatchtoolsFutureBackend
 #' @keywords internal
 #'
@@ -54,31 +52,30 @@ BatchtoolsLocalFutureBackend <- function(...) {
 #'
 #' The batchtools local backend is useful for verifying parts of your
 #' \pkg{batchtools} setup locally, before using a more advanced backend such
-#' as the job-scheduler backends. 
-#' An alternative to the batchtools interactive backend is to use
-#' `plan(future::cluster, workers = I(1))`.
+#' as the job-scheduler backends.
 #'
 #' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsLocalFutureBackend
 #'
 #' @param \ldots Not used.
 #'
 #' @details
-#' Batchtools local futures uses \pkg{batchtools} cluster functions
+#' Batchtools local futures use \pkg{batchtools} cluster functions
 #' created by [batchtools::makeClusterFunctionsInteractive()] with
 #' `external = TRUE`.
 #'
+#' An alternative to the batchtools interactive backend is to use
+#' `plan(future::cluster, workers = I(1))`.
+#'
 #' @examples
 #' plan(batchtools_local)
 #'
 #' message("Main process ID: ", Sys.getpid())
 #'
 #' f <- future(Sys.getpid())
 #' pid <- value(f)
-#' message("Workers process ID: ", pid)
+#' message("Worker process ID: ", pid)
 #' 
-#' @inheritParams BatchtoolsLocalFutureBackend
-#'
 #' @export
 batchtools_local <- function(...) {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_local() must never be called directly")

R/batchtools_multicore.R

@@ -26,7 +26,7 @@
 #' @rdname BatchtoolsFutureBackend
 #' @keywords internal
 #'
-#' @aliases batchtools_custom batchtools_multicore
+#' @aliases batchtools_custom
 #' @importFrom batchtools makeClusterFunctionsMulticore
 #' @importFrom parallelly availableCores supportsMulticore
 #' @importFrom tools pskill
@@ -71,8 +71,30 @@ 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.
+#'
+#' @details
+#' Batchtools multicore futures use \pkg{batchtools} cluster functions
+#' created by [batchtools::makeClusterFunctionsMulticore()] with
+#' `ncpus = workers`.
+#'
+#' An alternative to the batchtools multicore backend is to use
+#' `plan(future::multicore)`.
+#'
+#' @examples
+#' plan(batchtools_multicore, workers = 2)
+#'
+#' message("Main process ID: ", Sys.getpid())
+#'
+#' f <- future(Sys.getpid())
+#' pid <- value(f)
+#' message("Worker process ID: ", pid)
+#' 
 #' @export
 batchtools_multicore <- function(..., workers = availableCores(constraints = "multicore")) {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_multicore() must never be called directly")

R/batchtools_template.R

@@ -32,7 +32,7 @@
 #'    [TORQUE](https://en.wikipedia.org/wiki/TORQUE) / PBS
 #'
 #' @aliases BatchtoolsLsfFutureBackend BatchtoolsOpenLavaFutureBackend BatchtoolsSGEFutureBackend BatchtoolsSlurmFutureBackend BatchtoolsTorqueFutureBackend
-#' @aliases batchtools_lsf batchtools_openlava batchtools_sge batchtools_slurm batchtools_ssh batchtools_torque
+#' @aliases batchtools_lsf batchtools_openlava batchtools_sge batchtools_slurm batchtools_torque
 #'     
 #' @importFrom batchtools makeClusterFunctionsLSF
 #' @importFrom batchtools makeClusterFunctionsOpenLava