Retrieve species assessments by kingdom.
If kingdom_name = NULL
, it returns a list of available kingdoms.
If kingdom_name
is provided, it retrieves assessments for species in the specified kingdom.
Usage
rl_kingdoms(
kingdom_name = NULL,
year_published = NULL,
latest = NULL,
scope_code = NULL,
page = 1
)
Arguments
- kingdom_name
Character. The kingdom name (e.g., "Animalia"). Use
rl_kingdoms()
to list available kingdoms.- year_published
Optional. Single or numeric vector of years to filter assessments by publication year.
- latest
Optional. Logical. If
TRUE
, return only the latest assessment per species.- scope_code
Optional. Character. One or more scope codes to filter assessments.
- page
Optional. Integer vector. Specify one or more page numbers to fetch. If
NULL
orNA
, all pages will be fetched automatically.
Examples
if (FALSE) { # \dontrun{
# List all available kingdoms
rl_kingdoms()
# Get assessments for species in Animalia kingdom
rl_kingdoms(kingdom_name = "Animalia")
# Get latest assessments for Plantae published in 2021
rl_kingdoms(
kingdom_name = "Plantae",
year_published = 2021,
latest = TRUE
)
} # }