rgbif (version 0.9.7)

name_suggest: A quick and simple autocomplete service that returns up to 20 name usages by doing prefix matching against the scientific name. Results are ordered by relevance.

Description

A quick and simple autocomplete service that returns up to 20 name usages by doing prefix matching against the scientific name. Results are ordered by relevance.

Usage

name_suggest(q = NULL, datasetKey = NULL, rank = NULL, fields = NULL, start = NULL, limit = 100, ...)

Arguments

q

(character, required) Simple search parameter. The value for this parameter can be a simple word or a phrase. Wildcards can be added to the simple word parameters only, e.g. q=*puma*

datasetKey

(character) Filters by the checklist dataset key (a uuid, see examples)

rank

(character) A taxonomic rank. One of class, cultivar, cultivar_group, domain, family, form, genus, informal, infrageneric_name, infraorder, infraspecific_name, infrasubspecific_name, kingdom, order, phylum, section, series, species, strain, subclass, subfamily, subform, subgenus, subkingdom, suborder, subphylum, subsection, subseries, subspecies, subtribe, subvariety, superclass, superfamily, superorder, superphylum, suprageneric_name, tribe, unranked, or variety.

fields

(character) Fields to return in output data.frame (simply prunes columns off)

start

Record number to start at. Default: 0. Use in combination with limit to page through results.

limit

Number of records to return. Default: 100. Maximum: 1000.

...

Further named parameters, such as query, path, etc, passed on to modify_url within GET call. Unnamed parameters will be combined with config.

Value

A data.frame with fields selected by fields arg.

References

http://www.gbif.org/developer/species#searching

Examples

## Not run: 
# name_suggest(q='Puma concolor')
# name_suggest(q='Puma')
# name_suggest(q='Puma', rank="genus")
# name_suggest(q='Puma', rank="subspecies")
# name_suggest(q='Puma', rank="species")
# name_suggest(q='Puma', rank="infraspecific_name")
# 
# name_suggest(q='Puma', limit=2)
# name_suggest(q='Puma', fields=c('key','canonicalName'))
# name_suggest(q='Puma', fields=c('key','canonicalName','higherClassificationMap'))
# 
# # Pass on httr options
# library('httr')
# # res <- name_suggest(q='Puma', limit=200, config=progress())
# ## End(Not run)