future.batchtools (version 0.8.0)

delete.BatchtoolsFuture: Removes a batchtools future

Description

Removes a batchtools future

Usage

# S3 method for BatchtoolsFuture
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.