Cancel a download creation process.
occ_download_cancel(key, user = NULL, pwd = NULL, curlopts = list()) occ_download_cancel_staged(user = NULL, pwd = NULL, limit = 20, start = 0, curlopts = list())
key | (character) A key generated from a request, like that from
|
---|---|
user | (character) User name within GBIF's website. Required. See Details. |
pwd | (character) User password within GBIF's website. Required. See Details. |
curlopts | list of named curl options passed on to
|
limit | Number of records to return. Default: 20 |
start | Record number to start at. Default: 0 |
Note, these functions only cancel a job in progress. If your download is already prepared for you, this won't do anything to change that.
occ_download_cancel
cancels a specific job by download key - returns
success message
occ_download_cancel_staged
cancels all jobs with status RUNNING
or PREPARING
- if none are found, returns a message saying so -
if some found, they are cancelled, returning message saying so
see downloads for an overview of GBIF downloads methods
# NOT RUN { # occ_download_cancel(key="0003984-140910143529206") # occ_download_cancel_staged() # }