dot-downloadDataProduct: Public wrapper that lets a user download data products...

In onc.api: Oceans 2.0 API Client Library

Description

Public wrapper that lets a user download data products manually with a runId Can optionally return just the download links

Usage

.downloadDataProduct(
  self,
  runId = 0,
  maxRetries = 0,
  downloadResultsOnly = FALSE,
  includeMetadataFile = TRUE,
  overwrite = FALSE
)

Arguments

self	Calling object
runId	(numeric) Run ID as provided by runDataProduct()
maxRetries	(numeric) Maximum number of API requests allowed, 0 for no limit
downloadResultsOnly	(logical) When TRUE, files are not downloaded By default (FALSE) generated files are downloaded
includeMetadataFile	(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

onc.api documentation built on Aug. 21, 2021, 5:10 p.m.