rl_assessment: Retrieve an assessment

In ropenscilabs/rredlist: 'IUCN' Red List Client

Retrieve an assessment

Description

Get the full details for a single IUCN Red List assessment.

Usage

rl_assessment(id, key = NULL, parse = TRUE, ...)

rl_assessment_(id, key = NULL, ...)

Arguments

id	(integer) The unique identifier of the assessment.
key	(character) An IUCN API token. See rl_use_iucn().
parse	(logical) Whether to parse the output to list (FALSE) or, where possible, data.frame (TRUE). Default: TRUE.
...	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): pause_base, pause_cap, and pause_min: basis, maximum, and minimum for calculating wait time for retry times: the maximum number of times to retry onwait: a callback function if the request will be retried and a wait time is being applied 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/.

Examples

## Not run: 
# Get assessment details for Fratercula arctica
ex1 <- rl_assessment(id = 166290968)
ex1$red_list_category$code
ex1$systems

## End(Not run)

ropenscilabs/rredlist documentation built on Feb. 7, 2025, 2:28 a.m.