# Interface to the Global Biodiversity Information Facility API

## Documentation for package ‘rgbif’ version 3.8.5

- DESCRIPTION file
- Package NEWS

## Help Pages

A C D E G I L M N O P R T W

rgbif-package | Interface to the Global Biodiversity Information Facility API.

## -- A --

as.download | Import a downloaded file from GBIF.
as.download.character | Import a downloaded file from GBIF.
as.download.download | Import a downloaded file from GBIF.

## -- C --

check_wkt | Check input WKT
collection_export | Search GRSciColl collections
collection_search | Search GRSciColl collections
count_facet | Facetted count occurrence search.

## -- D --

dataset | Search for more obscure dataset metadata.
datasets | Search for datasets and dataset metadata.
dataset_comment | Get dataset metadata using a datasetkey
dataset_constituents | Get dataset metadata using a datasetkey
dataset_contact | Get dataset metadata using a datasetkey
dataset_doi | Get a GBIF dataset from a doi
dataset_duplicate | List datasets that are deleted or have no endpoint.
dataset_endpoint | Get dataset metadata using a datasetkey
dataset_export | Search for dataset metadata.
dataset_get | Get dataset metadata using a datasetkey
dataset_gridded | Check if a dataset is gridded
dataset_identifier | Get dataset metadata using a datasetkey
dataset_list_funs | List datasets that are deleted or have no endpoint.
dataset_machinetag | Get dataset metadata using a datasetkey
dataset_metrics | Get dataset metadata using a datasetkey
dataset_networks | Get dataset metadata using a datasetkey
dataset_noendpoint | List datasets that are deleted or have no endpoint.
dataset_process | Get dataset metadata using a datasetkey
dataset_search | Search for dataset metadata.
dataset_suggest | Search for dataset metadata.
dataset_tag | Get dataset metadata using a datasetkey
dataset_uuid_funs | Get dataset metadata using a datasetkey
derived_dataset | Register a derived dataset for citation.
derived_dataset_prep | Register a derived dataset for citation.
downloads | Downloads interface
download_predicate_dsl | Download predicate DSL (domain specific language)

## -- E --

elevation | Get elevation for lat/long points from a data.frame or list of points.
enumeration | Enumerations.
enumeration_country | Enumerations.

## -- G --

gbif_bbox2wkt | Convert a bounding box to a Well Known Text polygon, and a WKT to a bounding box
gbif_citation | Get citation for datasets used
gbif_geocode | Geocode lat-lon point(s) with GBIF's set of geo-polygons (experimental)
gbif_issues | List all GBIF issues and their codes.
gbif_issues_lookup | Lookup issue definitions and short codes
gbif_names | View highlighted terms in name results from GBIF.
gbif_oai | GBIF registry data via OAI-PMH
gbif_oai_get_records | GBIF registry data via OAI-PMH
gbif_oai_identify | GBIF registry data via OAI-PMH
gbif_oai_list_identifiers | GBIF registry data via OAI-PMH
gbif_oai_list_metadataformats | GBIF registry data via OAI-PMH
gbif_oai_list_records | GBIF registry data via OAI-PMH
gbif_oai_list_sets | GBIF registry data via OAI-PMH
gbif_photos | View photos from GBIF.
gbif_wkt2bbox | Convert a bounding box to a Well Known Text polygon, and a WKT to a bounding box

## -- I --

installations | Installations metadata.
installation_comment | Get installation metadata using an installation key
installation_contact | Get installation metadata using an installation key
installation_dataset | Get installation metadata using an installation key
installation_endpoint | Get installation metadata using an installation key
installation_identifier | Get installation metadata using an installation key
installation_machinetag | Get installation metadata using an installation key
installation_search | Search for installations
installation_tag | Get installation metadata using an installation key
installation_uuid_funs | Get installation metadata using an installation key
institution_export | Search GRSciColl institutions
institution_search | Search GRSciColl institutions

## -- L --

lit_count | Search for literature that cites GBIF mediated data
lit_export | Search for literature that cites GBIF mediated data
lit_search | Search for literature that cites GBIF mediated data

## -- M --

map_fetch | Fetch maps of GBIF occurrences
mvt_fetch | Fetch Map Vector Tiles (MVT)

## -- N --

name_backbone | Match names to GBIF backbone and other checklists.
name_backbone_checklist | Match names in the GBIF backbone taxonomy in a checklist.
name_backbone_verbose | Match names to GBIF backbone and other checklists.
name_issues | Parse and examine further GBIF name issues on a dataset.
name_lookup | Lookup names in all taxonomies in GBIF.
name_parse | Parse taxon names using the GBIF name parser.
name_suggest | Suggest up to 20 name usages.
name_usage | Lookup details for specific names in all taxonomies in GBIF.
network | Get data about GBIF networks
networks | Networks metadata.
network_constituents | Get data about GBIF networks
nodes | Nodes metadata.

## -- O --

occ_count | Get number of occurrence records.
occ_count_ | Get quick pre-computed occurrence counts of a limited number of dimensions.
occ_count_basis_of_record | Get quick pre-computed occurrence counts of a limited number of dimensions.
occ_count_country | Get quick pre-computed occurrence counts of a limited number of dimensions.
occ_count_pub_country | Get quick pre-computed occurrence counts of a limited number of dimensions.
occ_count_year | Get quick pre-computed occurrence counts of a limited number of dimensions.
occ_data | Legacy alternative to occ_search
occ_download | Spin up a download request for GBIF occurrence data.
occ_download_cached | Check for downloads already in your GBIF account
occ_download_cancel | Cancel a download creation process.
occ_download_cancel_staged | Cancel a download creation process.
occ_download_datasets | List datasets for a download
occ_download_dataset_activity | Lists the downloads activity of a dataset
occ_download_describe | Describes the fields available in GBIF downloads
occ_download_doi | Get download meta data from a doi
occ_download_get | Get a download from GBIF.
occ_download_import | Import a downloaded file from GBIF.
occ_download_list | Lists the downloads created by a user.
occ_download_meta | Retrieves the occurrence download metadata by its unique key.
occ_download_prep | Spin up a download request for GBIF occurrence data.
occ_download_queue | Download requests in a queue
occ_download_sql | Download occurrence data using a SQL query
occ_download_sql_prep | Download occurrence data using a SQL query
occ_download_sql_validate | Download occurrence data using a SQL query
occ_download_stats | Occurrence download statistics
occ_download_stats_dataset | Downloads by dataset
occ_download_stats_dataset_records | Downloaded records by dataset
occ_download_stats_export | Export summary of occurrence downloads
occ_download_stats_source | Downloads by source
occ_download_stats_user_country | Downloads by user country
occ_download_wait | Wait for an occurrence download to be done
occ_facet | Facet GBIF occurrences
occ_get | Get data for GBIF occurrences by occurrence key
occ_get_verbatim | Get data for GBIF occurrences by occurrence key
occ_issues | Parse and examine further GBIF occurrence issues on a dataset.
occ_metadata | Search for catalog numbers, collection codes, collector names, and institution codes.
occ_search | Search for GBIF occurrences
organizations | Organizations metadata.

## -- P --

parsenames | Parse taxon names using the GBIF name parser.
pred | Download predicate DSL (domain specific language)
pred_and | Download predicate DSL (domain specific language)
pred_default | Download predicate DSL (domain specific language)
pred_gt | Download predicate DSL (domain specific language)
pred_gte | Download predicate DSL (domain specific language)
pred_in | Download predicate DSL (domain specific language)
pred_isnull | Download predicate DSL (domain specific language)
pred_like | Download predicate DSL (domain specific language)
pred_lt | Download predicate DSL (domain specific language)
pred_lte | Download predicate DSL (domain specific language)
pred_not | Download predicate DSL (domain specific language)
pred_notnull | Download predicate DSL (domain specific language)
pred_or | Download predicate DSL (domain specific language)
pred_within | Download predicate DSL (domain specific language)

## -- R --

rgbif | Interface to the Global Biodiversity Information Facility API.
rgbif-defunct | Defunct functions in rgbif
rgb_country_codes | Look up 2 character ISO country codes

## -- T --

taxrank | Get the possible values to be used for (taxonomic) rank arguments in GBIF API methods.

## -- W --

wkt_parse | parse wkt into smaller bits