query: Query workflows

In labbcb/CromwellClient: R package for consuming Cromwell API

Description

Query for workflows which match various criteria. When a combination of criteria are applied the endpoint will return.

Usage

query(
  x,
  start = NULL,
  end = NULL,
  status = NULL,
  name = NULL,
  id = NULL,
  label = NULL,
  labelor = NULL,
  additionalQueryResultFields = NULL,
  version = "v1"
)

Arguments

x	Cromwell API endpoint.
start	Returns only workflows with an equal or later start datetime. Can be specified at most once. If both start and end date are specified, start date must be before or equal to end date.
end	Returns only workflows with an equal or earlier end datetime. Can be specified at most once. If both start and end date are specified, start date must be before or equal to end date.
status	Returns only workflows with the specified status. If specified multiple times, returns workflows in any of the specified statuses.
name	Returns only workflows with the specified name. If specified multiple times, returns workflows with any of the specified names.
id	ReturnsReturns only workflows with the specified workflow id. If specified multiple times, returns workflows with any of the specified workflow ids.
label	Returns workflows with the specified label keys. If specified multiple times, returns workflows with all of the specified label keys. Specify the label key and label value pair as separated with "label-key:label-value".
labelor	Returns workflows with the specified label keys. If specified multiple times, returns workflows with any of the specified label keys. Specify the label key and label value pair as separated with "label-key:label-value".
additionalQueryResultFields	Includes the specified keys in the metadata for the returned workflows.
version	Cromwell API Version.

Value

A data.frame.

Examples

## Not run: 
host <- "http://localhost:8000"
query(host)

## End(Not run)

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