cromwellQuery: Get the info about cromwell workflows

Description Usage Arguments Details Value Examples

View source: R/api.R

Description

Each of the following terms can be specified one or more times. Simply create a named list or named character vector.

Usage

1
2
cromwellQuery(name = NULL, id = NULL, status = NULL, start = NULL,
  end = NULL, label = NULL, ...)

Arguments

name

character vector of workflow names.

id

character vector of workflow IDs.

status

character vector of workflow status values. The available statuses are: Submitted, Running, Aborting, Aborted, Failed, and Succeeded.

start

a Date object specifying the workflow start time. Only workflows started after this are returned.

end

a Date object specifying the workflow end time. Only workflows that completed after this are returned.

label

character vector of workflow labels.

...

passed directly to httr 'GET' (for including 'timeouts', 'handles', etc.)

Details

name

The name of a job; may be specified more than once

status

one of Succeeded, Failed, Running

id

an id of a cromwell job

start

a timestamp of the form "2015-11-01T07:45:52.000-05:00", including mandatory offset

end

a timestamp of the form "2015-11-01T07:45:52.000-05:00", including mandatory offset

page

if paging is used, what page to select

pagesize

if paging is used, how many records per page

Value

a data.frame of query results

Examples

1
2
3
4
5
## Not run: 
res = cromwellQuery(status='Succeeded')
head(res)

## End(Not run)

seandavi/cRomwell documentation built on Oct. 28, 2021, 12:41 a.m.