rl_categories {rredlist} | R Documentation |
Red List category assessment summary
Description
Return a list of the latest assessments for a given category (e.g., Not Evaluated, Data Deficient, Least Concern, Near Threatened, Vulnerable, Endangered, Critically Endangered, Extinct in the Wild and Extinct). This endpoint returns categories for the current IUCN Red List Categories and Criteria (v3.1) as well as older versions (i.e., v2.3). Note that a code may not be unique across Categories and Criteria versions. Therefore, codes like "EX" will return assessments for EX v3.1 and EX v2.3.
Usage
rl_categories(
code = NULL,
key = NULL,
parse = TRUE,
all = TRUE,
page = 1,
quiet = FALSE,
...
)
rl_categories_(
code = NULL,
key = NULL,
all = TRUE,
page = 1,
quiet = FALSE,
...
)
Arguments
code |
(character) The code of the Red List category to look up. If not supplied, a list of all categories will be returned. |
key |
(character) An IUCN API token. See |
parse |
(logical) Whether to parse the output to list ( |
all |
(logical) Whether to retrieve all results at once or not. If
|
page |
(integer/numeric) Page to get if |
quiet |
(logical) Whether to suppress progress for multi-page downloads
or not. Default: |
... |
Includes the following filters that are supported by the API endpoint (refer to the API docs for more information):
Also includes the following arguments related to the wait time between request retries if a "Too Many Requests" error is received from the API (see HttpClient()$retry() for more details):
Also supports any curl options passed to the GET request via HttpClient. |
Value
A list unless using a function with a trailing underscore, in which case json as character string is returned.
References
API docs at https://api.iucnredlist.org/.
See Also
Assessments by threat details:
rl_pop_trends()
,
rl_stresses()
,
rl_threats()
,
rl_use_and_trade()
Examples
## Not run:
# Get all Red List categories
rl_categories()
# Get assessments for the Vulnerable category
rl_categories("VU")
## End(Not run)