rl_extinct_wild: Extinct taxa in the wild assessment summary

View source: R/rl_taxa.R

rl_extinct_wildR Documentation

Extinct taxa in the wild assessment summary

Description

Get an assessment summary for all taxa that are possibly extinct in the wild

Usage

rl_extinct_wild(
  key = NULL,
  parse = TRUE,
  all = TRUE,
  page = 1,
  quiet = FALSE,
  ...
)

rl_extinct_wild_(key = NULL, all = TRUE, page = 1, quiet = FALSE, ...)

Arguments

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

all

(logical) Whether to retrieve all results at once or not. If TRUE we do the paging internally for you and bind all of the results together. If FALSE, only a single page of results will be retrieved.

page

(integer/numeric) Page to get if all is FALSE. Default: 1. Each page returns up to 100 records. Paging is required because it's too much burden on a server to just "get all the data" in one request.

quiet

(logical) Whether to suppress progress for multi-page downloads or not. Default: FALSE (that is, give progress). Ignored if all = FALSE.

...

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 for specific sets of taxa rl_comp_groups(), rl_extinct(), rl_green(), rl_growth_forms()

Examples

## Not run: 
ex1 <- rl_extinct_wild()
nrow(ex1$assessments)

## End(Not run)

ropensci/rredlist documentation built on Oct. 12, 2024, 11:57 p.m.