cromwell_call: Retrieve metadata for the calls made in a Cromwell workflow...

In FredHutch/fh.wdlR: Convenience Tools for Managing WDL Workflows via Cromwell

Retrieve metadata for the calls made in a Cromwell workflow job

Description

Retrieve and process call metadata for a specific workflow.

Usage

cromwell_call(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

Details

Now supports nested scatters.

Value

Returns a long form data frame of metadata on calls. NOTE: does not currently support subWorkflows well yet.

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]
callsMeta <- cromwell_call(workflow_id = thisWorkflowID)

## End(Not run)

FredHutch/fh.wdlR documentation built on Sept. 23, 2024, 7:43 a.m.