Skip to contents

Get the latest assessment for a particular taxonomic entity based on its ID number from the IUCN Species Information Service (SIS). Wraps rl_sis() and rl_assessment().

Usage

rl_sis_latest(id, scope = "1", key = NULL, parse = TRUE, ...)

Arguments

id

(integer) The SIS ID of the taxonomic entity to look up.

scope

(character) An optional scope (see rl_scopes()) to filter the results by. The default, "1", returns the latest global assessment. If no assessments exist for the specified scope, the latest assessment across all scopes is returned. If NULL, the latest assessment across all scopes is returned.

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/.

See also

Examples

if (FALSE) { # \dontrun{
# Get latest assessment for species
ex1 <- rl_sis_latest(id = 9404)
ex1$stresses
} # }