abort: Abort a running workflow

In labbcb/CromwellClient: R package for consuming Cromwell API

Description

Request Cromwell to abort a running workflow. For instance this might be necessary in cases where you have submitted a workflow with incorrect inputs or no longer need the results. Cromwell will make a best effort attempt to immediately halt any currently running jobs from this workflow.

Usage

abort(x, ...)

## S3 method for class 'character'
abort(x, id, version = "v1", ...)

## S3 method for class 'WorkflowIdAndStatus'
abort(x, ...)

Arguments

x	Cromwell API endpoint of WorkflowIdAndStatus object.
...	not used
id	A workflow ID.
version	Cromwell API Version.

Value

WorkflowIdAndStatus object containing status and id.

Examples

## Not run: 
host <- "http://localhost:8000"
workflow <- system.file("extdata/workflow.wdl", package = "CromwellClient")
inputs <- system.file("extdata/inputs.json", package = "CromwellClient")
job <- submit(host, workflow, inputs)
abort(job)

## End(Not run)

labbcb/CromwellClient documentation built on Aug. 16, 2020, 9:11 p.m.