cromwell_failures: Pull metadata for the failed calls made in a Cromwell...

View source: R/cromwellFailures.R

cromwell_failuresR Documentation

Pull metadata for the failed calls made in a Cromwell workflow job

Description

Gets info about failed calls for a specific workflow

Usage

cromwell_failures(workflow_id, url = cw_url(), token = NULL)

Arguments

workflow_id

(character) A single workflow ID

url

(character) base url for your Cromwell server. optional. if not supplied set the url as the env var CROMWELLURL

token

(character) we do not recommend passing your token here as a string. Either pass it using Sys.getenv() or save your token as the env var PROOF_TOKEN and then passing nothing to this param and we'll find it

Value

a tibble of metadata on failed calls in a workflow; columns vary depending on workflow; if no results, a zero row tibble

Important

Requires valid Cromwell server URL to be set. See cromwell_settings

Author(s)

Amy Paguirigan, Scott Chamberlain

Examples

## Not run: 
## Request what jobs have been submitted to your Cromwell instance in the
## past 7 days.
recentJobs <- cromwell_jobs(days = 7)
## Request workflow metadata for a specific job that was run in your
## Cromwell instance.
thisWorkflowID <- recentJobs$workflow_id[1]
failsMeta <- cromwell_failures(workflow_id = thisWorkflowID)

## End(Not run)

FredHutch/fh.wdlR documentation built on March 26, 2024, 8:40 p.m.