delete.BatchJobsFuture: Removes a BatchJobs future

In HenrikBengtsson/future.BatchJobs: A Future API for Parallel and Distributed Processing using BatchJobs

Description

Removes a BatchJobs future

Usage

## S3 method for class 'BatchJobsFuture'
delete(
  future,
  onRunning = c("warning", "error", "skip"),
  onFailure = c("error", "warning", "ignore"),
  onMissing = c("ignore", "warning", "error"),
  times = 10L,
  delta = getOption("future.wait.interval", 1),
  alpha = getOption("future.wait.alpha", 1.01),
  ...
)

Arguments

future	The future.
onRunning	Action if future is running or appears to run.
onFailure	Action if failing to delete future.
onMissing	Action if future does not exist.
times	The number of tries before giving up.
delta	The delay interval (in seconds) between retries.
alpha	A multiplicative penalty increasing the delay for each failed try.
...	Not used.

Value

(invisibly) TRUE if deleted and FALSE otherwise.

HenrikBengtsson/future.BatchJobs documentation built on Feb. 15, 2021, 3:17 a.m.