onc.api (version 2.0.1.0)

.orderDataProduct: Request, run and download a data product as described by the filters

Description

Request, run and download a data product as described by the filters

Usage

.orderDataProduct(
  self,
  filters = list(),
  maxRetries = 0,
  downloadResultsOnly = FALSE,
  metadata = TRUE,
  overwrite = FALSE
)

Arguments

self

Caling object

filters

(named list) Filters that describe this data product

maxRetries

(numeric) Total maximum number of request calls allowed, 0 for no limit

downloadResultsOnly

(logical) When TRUE, files are not downloaded By default (FALSE) generated files are downloaded

metadata

(logical) When TRUE, a metadata file is downloaded, otherwise it is skipped

overwrite

(logical) When TRUE downloaded files will overwrite any file with the same filename, otherwise they will be skipped

Value

(list) A list of results (one named list for each file) with information on the operation outcome