dot-downloadProductFiles: Download all data product files for provided run id
In bennitm/oceans2.0_api_R_client: Oceans 2.0 API Client Library
Description
Usage
Arguments
Value
Description
Download all data product files for provided run id
Usage
1
2
3
4
5
6
7
8
.downloadProductFiles(
self,
runId = 0,
getMetadata = TRUE,
maxRetries = 0,
overwrite = TRUE,
fileCount = 0
)
Arguments
self
Caling object
runId
Run id returned by .runDataProduct()
getMetadata
When TRUE, the metadata file will be downloaded
maxRetries
(numeric) Maximum number of API requests allowed, 0 for no limit
overwrite
(logical) When TRUE downloaded files will overwrite any file
with the same filename, otherwise they will be skipped
fileCount
The number of files to download, or 0 if unknown
Value
a list of named lists, with the results for each file
bennitm/oceans2.0_api_R_client documentation built on Dec. 19, 2021, 8:44 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value
Description
Download all data product files for provided run id
Usage
1 2 3 4 5 6 7 8 | .downloadProductFiles(
self,
runId = 0,
getMetadata = TRUE,
maxRetries = 0,
overwrite = TRUE,
fileCount = 0
)
|
Arguments
self |
Caling object |
runId |
Run id returned by .runDataProduct() |
getMetadata |
When TRUE, the metadata file will be downloaded |
maxRetries |
(numeric) Maximum number of API requests allowed, 0 for no limit |
overwrite |
(logical) When TRUE downloaded files will overwrite any file with the same filename, otherwise they will be skipped |
fileCount |
The number of files to download, or 0 if unknown |
Value
a list of named lists, with the results for each file
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.