metadata: Get workflow and call-level metadata for a specified workflow

In labbcb/CromwellClient: R package for consuming Cromwell API

Description

Get workflow and call-level metadata for a specified workflow

Usage

metadata(x, ...)

## S3 method for class 'character'
metadata(
  x,
  id,
  version = "v1",
  includeKey = NULL,
  excludeKey = NULL,
  expandSubWorkflows = FALSE,
  ...
)

## S3 method for class 'WorkflowIdAndStatus'
metadata(
  x,
  includeKey = NULL,
  excludeKey = NULL,
  expandSubWorkflows = FALSE,
  ...
)

Arguments

x	Cromwell API endpoint of WorkflowIdAndStatus object.
...
id	A workflow ID.
version	Cromwell API Version.
includeKey	When specified key(s) to include from the metadata. Matches any key starting with the value. May not be used with excludeKey. This applies to all keys in the response, including within nested blocks.
excludeKey	When specified key(s) to exclude from the metadata. Matches any key starting with the value. May not be used with includeKey. This applies to all keys in the response, including within nested blocks.
expandSubWorkflows	When true, metadata for sub workflows will be fetched and inserted automatically in the metadata response.

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)
status(job)

## End(Not run)

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