rl_comp_groups: Information about comprehensive groups

View source: R/rl_comp_groups.R

rl_comp_groupsR Documentation

Information about comprehensive groups

Description

Information about comprehensive groups

Usage

rl_comp_groups(group = NULL, key = NULL, parse = TRUE, ...)

rl_comp_groups_(group = NULL, key = NULL, ...)

Arguments

group

(character) A comprehensive group name. Call rl_comp_groups() without passing this parameter to get the list of comprehensive groups

key

A IUCN API token. See rl_use_iucn.

parse

(logical) Whether to parse to list (FALSE) or data.frame (TRUE). Default: TRUE

...

Curl options passed to HttpClient

Value

A list, with the data in the result slot, unless using a function with a trailing underscore, in which case json as character string is returned.

References

API docs at https://apiv3.iucnredlist.org/api/v3/docs

Examples

## Not run: 
rl_comp_groups()
rl_comp_groups('mammals')
rl_comp_groups('groupers')

rl_comp_groups_()
rl_comp_groups_('groupers')

## End(Not run)

ropenscilabs/rredlist documentation built on Nov. 18, 2022, 7:06 p.m.