institutionKey not available for occ_download()

[veronicar239]

Good day,
I'm using the key parameter "institutionKey" in occ_count() and occ_search() queries, and would like to use institutionKey for the occ_download() function. I am specifically using institutionKey (instead of institutionCode) because it is the highest level identifier of an institution (which may include multiple institutionCode for a given institution). The institutionKey variable is the primary GBIF identifier.

occ_download_prep(pred_or(pred("institutionKey", '586ee56e-b0fe-4dff-b7f9-aeb104f3308a'), pred("institutionKey", 'be5b9c72-e499-42b8-a5dc-c27505cf232e')))

Error: 'institutionKey' not in acceptable set of keys; see ?download_predicate_dsl

I saw in the ?download_predicate_dsl it says to "Open an issue in the GitHub repository for this package if you know of a key that should be supported that is not yet."

Also, it would be very useful to have institutionKey as a variable in the DWCA format download since the variable "institutionCode" is not a 1:1 equivalent to institutionKey. I think it is common to use an institution level variable for data downloads and analysis/visualization in R. For example, the occ_count() function shows that using institutionKey results in a higher number of occurrences for USNM. Thus, it's unclear what would be listed in the institutionCode variable if you download the larger dataset using institutionKey.

occ_count(institutionKey='586ee56e-b0fe-4dff-b7f9-aeb104f3308a')
[1] 6011853

occ_count(institutionCode="USNM")
[1] 5939950

I'm using R version 4.4.1 (2024-06-14). Thanks!

[jhnwllr]

I will add institutionKey to the new version 3.8.2, which I hope to release in the next few days.

https://docs.ropensci.org/rgbif/reference/download_predicate_dsl.html

[veronicar239]

@jhnwllr that's fantastic news, thanks!