occ_download() doesn't have a Value section

[oharar]

The background is that I'm trying to download GBIF data from the download DOI, and am going round in circles. The specific problem is that occ_download_import() has the argument 'key', which is described as "A key generated from a request, like that from occ_download". But without any documentation on what occ_download() returns I can't get any further working out what I should be doing.

(also - "Spin up a download request for GBIF occurrence data." is unclear: why not use "Prepare..."?)

[jhnwllr]

Hi @oharar,

Thanks for writing.

There is a new function in the newest development version called occ_download_doi().

This will allow you get a GBIF download key (and other meta data) with a DOI.

pak::pkg_install("ropensci/rgbif") # dev version

Example usage below.

library(rgbif) 

occ_download_doi("10.15468/dl.zdfkkf")$key %>%
occ_download_get() %>%
occ_download_import()

Note that if you have the downloadKey, you can use it directly with occ_download_get("0002011-250415084134356") %>% occ_download_import.

When you send a download request to GBIF with occ_download(), you should see a print out like this. The download key (in this case 0028400-240906103802322) will be different for your download.

<<gbif download sql>>
  Your download is being processed by GBIF:
  https://www.gbif.org/occurrence/download/0028400-240906103802322
  Check status with
  occ_download_wait('0028400-240906103802322')
  After it finishes, use
  d <- occ_download_get('0028400-240906103802322') %>%
    occ_download_import()
  to retrieve your download.
Download Info:
  Username: jwaller
  E-mail: jwaller@gbif.org
  Format: SQL_TSV_ZIP
  Download key: 0028400-240906103802322
  Created: 2024-09-24T14:05:47.599+00:00
Citation Info:  
  Please always cite the download DOI when using this data.
  https://www.gbif.org/citation-guidelines
  DOI: 10.15468/dl.fnrv3s
  Citation:
  GBIF Occurrence Download https://doi.org/10.15468/dl.fnrv3s Accessed from R via rgbif (https://github.com/ropensci/rgbif) on 2024-09-24