CLEANUP: Removed S3 generic await(); it is only used internally and can be a regular function (fixes #58)

Author: HenrikBengtsson

NAMESPACE

@@ -1,6 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
-S3method(await,BatchtoolsFuture)
 S3method(delete,BatchtoolsFuture)
 S3method(finished,BatchtoolsFuture)
 S3method(loggedError,BatchtoolsFuture)
@@ -14,6 +13,7 @@ S3method(status,BatchtoolsFuture)
 export("%resources%")
 export(BatchtoolsFuture)
 export(BatchtoolsFutureError)
+export(await)
 export(batchtools_custom)
 export(batchtools_interactive)
 export(batchtools_local)

NEWS

@@ -1,13 +1,16 @@
 Package: future.batchtools
 ==========================
 
-Version: 0.9.0-9000 [2020-12-23]
+Version: 0.9.0-9000 [2021-01-02]
 
 SIGNIFICANT CHANGES:
 
  * Lazy batchtools futures only creates the internal batchtools registry when
    the future is launched.
 
+ * Removed S3 generic await(), which is a function that was only used for
+   internal purposes.
+
 DOCUMENTATION:
 
  * Document option 'future.delete' and clarify option 'future.cache.path'
@@ -18,6 +21,11 @@ BUG FIXES:
  * If run() was called twice for a BatchtoolsFuture, it would not produce
    a FutureError but only a regular non-classed error.
 
+DEPRECATED AND DEFUNCT:
+
+ * Removed S3 generic await(), which is a function that was only used for
+   internal purposes.
+
 
 Version: 0.9.0 [2020-04-14]
 

R/BatchtoolsFuture-class.R

@@ -502,8 +502,6 @@ run.BatchtoolsFuture <- function(future, ...) {
 } ## run()
 
 
-await <- function(...) UseMethod("await")
-
 #' Awaits the value of a batchtools future
 #'
 #' @param future The future.
@@ -528,13 +526,11 @@ await <- function(...) UseMethod("await")
 #' @importFrom batchtools getErrorMessages loadResult waitForJobs
 #' @importFrom utils tail
 #' @keywords internal
-await.BatchtoolsFuture <- function(future, cleanup = TRUE,
-                                   timeout = getOption("future.wait.timeout",
-                                                       30 * 24 * 60 * 60),
-                                   delta = getOption("future.wait.interval",
-                                                     1.0),
-                                   alpha = getOption("future.wait.alpha", 1.01),
-                                   ...) {
+await <- function(future, cleanup = TRUE,
+                  timeout = getOption("future.wait.timeout", 30 * 24 * 60 * 60),
+                  delta = getOption("future.wait.interval", 1.0),
+                  alpha = getOption("future.wait.alpha", 1.01),
+                  ...) {
   stop_if_not(is.finite(timeout), timeout >= 0)
   stop_if_not(is.finite(alpha), alpha > 0)
 

R/options.R

@@ -54,7 +54,7 @@
 #' options(future.cache.path = "/cluster-wide/folder/.future")
 #'
 #' # Set an environment variable:
-#' Sys.setenv(R_FUTURE_RNG_ONMISUSE = "/cluster-wide/folder/.future")
+#' Sys.setenv(R_FUTURE_CACHE_PATH = "/cluster-wide/folder/.future")
 #' 
 #' @aliases
 #' future.cache.path