HELP: Add Wikipedia references for all job schedulers

Author: HenrikBengtsson

DESCRIPTION

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

R/batchtools_lsf.R

@@ -7,7 +7,7 @@ BatchtoolsLsfFutureBackend <- function(...) {
 }
 
 
-#' A batchtools LSF backend resolves futures in parallel via a LSF job scheduler
+#' A batchtools LSF backend resolves futures in parallel via a Load Sharing Facility (LSF) job scheduler
 #'
 #' @inheritParams BatchtoolsFutureBackend
 #' @inheritParams BatchtoolsTemplateFutureBackend
@@ -44,6 +44,9 @@ BatchtoolsLsfFutureBackend <- function(...) {
 #' pid <- value(f)
 #' message("Worker process ID: ", pid)
 #' 
+#' @references
+#' * <https://en.wikipedia.org/wiki/IBM_Spectrum_LSF>
+#'
 #' @export
 batchtools_lsf <- function(..., template = "lsf") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_lsf() must never be called directly")

R/batchtools_openlava.R

@@ -43,7 +43,10 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 #' f <- future(Sys.getpid())
 #' pid <- value(f)
 #' message("Worker process ID: ", pid)
-#' 
+#'
+#' @references
+#' * <https://en.wikipedia.org/wiki/OpenLava>
+#'
 #' @export
 batchtools_openlava <- function(..., template = "openlava") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_openlava() must never be called directly")

R/batchtools_sge.R

@@ -43,6 +43,9 @@ BatchtoolsSGEFutureBackend <- function(...) {
 #' pid <- value(f)
 #' message("Worker process ID: ", pid)
 #' 
+#' @references
+#' * <https://en.wikipedia.org/wiki/Oracle_Grid_Engine>
+#'
 #' @export
 batchtools_sge <- function(..., template = "sge") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_sge() must never be called directly")

R/batchtools_slurm.R

@@ -43,7 +43,10 @@ BatchtoolsSlurmFutureBackend <- function(...) {
 #' f <- future(Sys.getpid())
 #' pid <- value(f)
 #' message("Worker process ID: ", pid)
-#' 
+#'
+#' @references
+#' * <https://en.wikipedia.org/wiki/Slurm_Workload_Manager>
+#'
 #' @export
 batchtools_slurm <- function(..., template = "slurm") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_slurm() must never be called directly")

R/batchtools_torque.R

@@ -43,6 +43,9 @@ BatchtoolsTorqueFutureBackend <- function(...) {
 #' pid <- value(f)
 #' message("Worker process ID: ", pid)
 #' 
+#' @references
+#' * <https://en.wikipedia.org/wiki/TORQUE>
+#'
 #' @export
 batchtools_torque <- function(..., template = "torque") {
  stop("INTERNAL ERROR: The future.batchtools::batchtools_torque() must never be called directly")