occ_download_sql: Download occurrence data using a SQL query

In rgbif: Interface to the Global Biodiversity Information Facility API

Download occurrence data using a SQL query

Description

Download occurrence data using a SQL query

Usage

occ_download_sql(
  q = NULL,
  format = "SQL_TSV_ZIP",
  user = NULL,
  pwd = NULL,
  email = NULL,
  validate = TRUE,
  curlopts = list()
)

occ_download_sql_validate(q = NULL, user = NULL, pwd = NULL)

occ_download_sql_prep(
  q = NULL,
  format = "SQL_TSV_ZIP",
  user = NULL,
  pwd = NULL,
  email = NULL,
  validate = TRUE,
  curlopts = list()
)

Arguments

q	sql query
format	only "SQL_TSV_ZIP" is supported right now
user	your GBIF user name
pwd	your GBIF password
email	your email address
validate	should the query be validated before submission. Default is TRUE.
curlopts	list of curl options

Details

This is an experimental feature, and the implementation may change throughout 2024. The feature is currently only available for preview by invited users. Contact [e-mail] to request access.

Please see the article here for more information: https://docs.ropensci.org/rgbif/articles/getting_occurrence_data.html

Value

an object of class 'occ_download_sql'

References

https://techdocs.gbif.org/en/data-use/api-sql-downloads

Examples

## Not run: 
occ_download_sql("SELECT gbifid,countryCode FROM occurrence 
                  WHERE genusKey = 2435098")

## End(Not run)

rgbif documentation built on Sept. 27, 2024, 5:07 p.m.