rgbif (version 0.6.2)

name_usage: Lookup details for specific names in all taxonomies in GBIF.

Description

This service uses fuzzy lookup so that you can put in partial names and you should get back those things that match. See examples below.

This function is different from name_lookup in that that function searches for names, while this function requires that you already have a key.

Note that verbatim hasn't been working for me.

Options for the data parameter are: 'all', 'verbatim', 'name', 'parents', 'children', 'descendants', 'related', 'synonyms', 'descriptions','distributions', 'images', 'references', 'species_profiles', 'vernacular_names', 'type_specimens'

Usage

name_usage(key = NULL, name = NULL, data = "all", language = NULL,
  datasetKey = NULL, uuid = NULL, sourceId = NULL, rank = NULL,
  shortname = NULL, start = NULL, limit = 20, callopts = list())

Arguments

callopts

Pass on options to httr::GET for more refined control of http calls, and error handling

limit

Number of records to return

start

Record number to start at

rank

(character) Taxonomic rank. Filters by taxonomic rank as one of: CLASS, CULTIVAR, CULTIVAR_GROUP, DOMAIN, FAMILY, FORM, GENUS, INFORMAL, INFRAGENERIC_NAME, INFRAORDER, INFRASPECIFIC_NAME, INFRASUBSPECIFIC_NAME, KINGDOM, ORDER, PHYLUM, SECTION, SERIES,

datasetKey

(character) Filters by the dataset's key (a uuid)

uuid

(character) A uuid for a dataset. Should give exact same results as datasetKey.

key

(numeric) A GBIF key for a taxon

name

(character) Filters by a case insensitive, canonical namestring, e.g. 'Puma concolor'

data

(character) Specify an option to select what data is returned. See Description below.

language

(character) Language, default is english

sourceId

(numeric) Filters by the source identifier. Not used right now.

shortname

(character) A short name..need more info on this?

Value

• A list of length two. The first element is metadata. The second is either a data.frame (verbose=FALSE, default) or a list (verbose=TRUE)

References

http://www.gbif.org/developer/summary

Examples

# All name usages
name_usage()

# A single name usage
name_usage(key=1)

# Name usage for a taxonomic name
name_usage(name='Puma concolor')

# References for a name usage
name_usage(key=3119195, data='references')

# Species profiles, descriptions
name_usage(key=3119195, data='species_profiles')
name_usage(key=3119195, data='descriptions')
res <- name_usage(key=2435099, data='children')
sapply(res$results, "[[", "scientificName")

# Vernacular names for a name usage
name_usage(key=3119195, data='vernacular_names')

# Select many options
name_usage(key=3119195, data=c('images','synonyms'))

# Limit number of results returned
name_usage(key=3119195, data='vernacular_names', limit=3)

# Search for names by dataset with datasetKey parameter
name_usage(datasetKey="d7dddbf4-2cf0-4f39-9b2a-bb099caae36c")

# Search for a particular language
name_usage(key=3119195, language="FRENCH", data='vernacular_names')