rl_search: Search by taxon name, IUCN id, and region

In ropenscilabs/rredlist: 'IUCN' Red List Client

Search by taxon name, IUCN id, and region

Description

Search by taxon name, IUCN id, and region

Usage

rl_occ_country_(name = NULL, id = NULL, region = NULL, key = NULL, ...)

rl_search(name = NULL, id = NULL, region = NULL, key = NULL, parse = TRUE, ...)

rl_search_(name = NULL, id = NULL, region = NULL, key = NULL, ...)

Arguments

name	(character) A taxonomic name
id	(character) An IUCN identifier
region	(character) A region name, see rl_regions for acceptable region identifiers (use the entries in the identifier column)
key	A IUCN API token. See rl_use_iucn.
...	Curl options passed to HttpClient
parse	(logical) Whether to parse to list (FALSE) or data.frame (TRUE). Default: TRUE

Value

A list, with the data in the result slot, unless using a function with a trailing underscore, in which case json as character string is returned.

References

API docs at https://apiv3.iucnredlist.org/api/v3/docs

Examples

## Not run: 
rl_search('Fratercula arctica')
rl_search('Fratercula arctica', region = 'europe')
rl_search(id = 12392)
rl_search(id = 22694927, region = 'europe')

rl_search('Fratercula arctica', parse = FALSE)
rl_search_('Fratercula arctica')
rl_search_('Fratercula arctica', region = 'europe')

## End(Not run)

ropenscilabs/rredlist documentation built on Nov. 18, 2022, 7:06 p.m.