cromwell_glob: Pull a glob of metadata for a specific Cromwell workflow job

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

Pull a glob of metadata for a specific Cromwell workflow job

Description

Retrieve a glob of workflow level metadata for a specific workflow.

Usage

cromwell_glob(
  workflow_id,
  expand_sub_workflows = FALSE,
  url = cw_url(),
  token = NULL
)

Arguments

workflow_id	(character) A single workflow ID
expand_sub_workflows	Boolean, whether to expand subworkflows in the results or not (default: FALSE)
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 list of metadata on a workflow

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]
workflowMeta <- cromwell_glob(workflow_id = thisWorkflowID)

## End(Not run)

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