Skip to contents

SIS ID assessment summary

Source: R/rl_taxa.R
rl_sis.Rd

Get an assessment summary for a particular taxonomic entity based on its ID number from the IUCN Species Information Service (SIS).

Usage

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

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

Arguments

id

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

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

Assessments by taxa: rl_class(), rl_family(), rl_kingdom(), rl_order(), rl_phylum(), rl_sis_latest(), rl_species(), rl_species_latest()

Examples

if (FALSE) { # \dontrun{
# Get assessment summary for species
ex1 <- rl_sis(id = 9404)
nrow(ex1$assessments)
} # }