Package: rredlist 1.0.0.9000

William Gearty

rredlist: 'IUCN' Red List Client

'IUCN' Red List (<https://api.iucnredlist.org/>) client. The 'IUCN' Red List is a global list of threatened and endangered species. Functions cover all of the Red List 'API' routes. An 'API' key is required.

Authors:William Gearty [aut, cre], Scott Chamberlain [aut], rOpenSci [fnd], Maëlle Salmon [ctb], Kevin Cazelles [rev], Stephanie Hazlitt [rev]

rredlist_1.0.0.9000.tar.gz
rredlist_1.0.0.9000.zip(r-4.5)rredlist_1.0.0.9000.zip(r-4.4)rredlist_1.0.0.9000.zip(r-4.3)
rredlist_1.0.0.9000.tgz(r-4.5-any)rredlist_1.0.0.9000.tgz(r-4.4-any)rredlist_1.0.0.9000.tgz(r-4.3-any)
rredlist_1.0.0.9000.tar.gz(r-4.5-noble)rredlist_1.0.0.9000.tar.gz(r-4.4-noble)
rredlist_1.0.0.9000.tgz(r-4.4-emscripten)rredlist_1.0.0.9000.tgz(r-4.3-emscripten)
rredlist.pdf |rredlist.html✨
rredlist/json (API)
NEWS

# Install 'rredlist' in R:
install.packages('rredlist', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org'))

Reviews:rOpenSci Software Review #663

Bug tracker:https://github.com/ropensci/rredlist/issues1 issues

Pkgdown site:https://docs.ropensci.org

On CRAN:rredlist-1.0.0(2025-01-31)

Conda:r-rredlist-1.0.0(2025-03-25)

iucnbiodiversityapiweb-servicestraitshabitatspeciesconservationapi-wrapperiucn-red-listtaxize

11.49 score 53 stars 24 packages 195 scripts 7.0k downloads 2 mentions 88 exports 13 dependencies

Last updated 1 months agofrom:cc166729a4 (on main). Checks:9 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKMar 14 2025
R-4.5-winOKMar 14 2025
R-4.5-macOKMar 14 2025
R-4.5-linuxOKMar 14 2025
R-4.4-winOKMar 14 2025
R-4.4-macOKMar 14 2025
R-4.4-linuxOKMar 14 2025
R-4.3-winOKMar 14 2025
R-4.3-macOKMar 14 2025

Exports:rl_actionsrl_actions_rl_api_versionrl_assessmentrl_assessment_rl_categoriesrl_categories_rl_citationrl_classrl_class_rl_common_namesrl_common_names_rl_comp_groupsrl_comp_groups_rl_countriesrl_countries_rl_extinctrl_extinct_rl_extinct_wildrl_extinct_wild_rl_familyrl_family_rl_faosrl_faos_rl_greenrl_green_rl_growth_formsrl_growth_forms_rl_habitatsrl_habitats_rl_historyrl_history_rl_kingdomrl_kingdom_rl_measuresrl_measures_rl_narrativerl_narrative_rl_occ_countryrl_occ_country_rl_orderrl_order_rl_phylumrl_phylum_rl_pop_trendsrl_pop_trends_rl_realmsrl_realms_rl_regionsrl_regions_rl_researchrl_research_rl_scopesrl_scopes_rl_searchrl_search_rl_sisrl_sis_rl_sis_latestrl_sprl_sp_rl_sp_categoryrl_sp_category_rl_sp_citationrl_sp_citation_rl_sp_countrl_sp_count_rl_sp_countryrl_sp_country_rl_speciesrl_species_rl_species_latestrl_stressesrl_stresses_rl_synonymsrl_synonyms_rl_systemsrl_systems_rl_threatsrl_threats_rl_use_and_traderl_use_and_trade_rl_use_iucnrl_versionscale_color_iucnscale_colour_iucnscale_discrete_iucnscale_fill_iucn

Dependencies:clicrulcurlgluehttpcodejsonlitelifecyclemimeR6Rcpprlangtriebeardurltools

Introduction to rredlist

William Gearty

Rendered fromrredlist.Rmdusingknitr::rmarkdownon Mar 14 2025.

Last update: 2025-01-28
Started: 2020-10-14

rredlist benchmarks

William Gearty

Rendered frombenchmarks.Rmdusingknitr::rmarkdownon Mar 14 2025.

Last update: 2025-01-28
Started: 2025-01-28

Using rredlist within a research workflow

William Gearty

Rendered fromresearch_workflows.Rmdusingknitr::rmarkdownon Mar 14 2025.

Last update: 2025-01-28
Started: 2025-01-28

Citation

Gearty W, Chamberlain S (2025). rredlist: 'IUCN' Red List Client. doi:10.32614/CRAN.package.rredlist, R package version 1.0.0, https://docs.ropensci.org/rredlist/.

Corresponding BibTeX entry: 

  @Manual{rredlist,
    title = {rredlist: 'IUCN' Red List Client},
    author = {William Gearty and Scott Chamberlain},
    year = {2025},
    note = {R package version 1.0.0},
    doi = {10.32614/CRAN.package.rredlist},
    url = {https://docs.ropensci.org/rredlist/},
  }

Readme and manuals

rredlist

rredlist is an R client for the IUCN Red List API (https://api.iucnredlist.org). The IUCN Red List is the world’s most comprehensive information source on the global extinction risk status of animal, fungus, and plant species. This package provides access via R to the various data contained within this database which span range details, population size, habitat and ecology, use and/or trade, threats, and conservation actions. The functions within the package cover all endpoints of the IUCN Red List web API, which are documented here.

Installation

CRAN

install.packages("rredlist")

Development version

# remotes::install_github("ropensci/rredlist")
install.packages("rredlist", repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org'))
# OR
install.packages("rredlist", repos = "https://ropensci.r-universe.dev/")

Authentication

Use of this package requires an IUCN API key which can be acquired at https://api.iucnredlist.org/users/sign_up. There is a helper function to help you get the key and store it properly:

rredlist::rl_use_iucn()

Keep this key private. You can pass the key in to each function via the key parameter, but it’s better to store the key either as an environment variable (IUCN_REDLIST_KEY) or an R option (iucn_redlist_key) - we recommend using the former option. Note that there is not a default API key that is used as a fallback, and the package will not function without providing/storing your own API key.

Example usage

Loading the package
library("rredlist")
Search for assessments for a particular species
rl_species("Gorilla", "gorilla")$assessments
#>    year_published latest possibly_extinct possibly_extinct_in_the_wild sis_taxon_id
#> 1            2016  FALSE            FALSE                        FALSE         9404
#> 2            2018   TRUE            FALSE                        FALSE         9404
#> 3            2016  FALSE            FALSE                        FALSE         9404
#> 4            2008  FALSE            FALSE                        FALSE         9404
#> 5            2007  FALSE            FALSE                        FALSE         9404
#> 6            2000  FALSE            FALSE                        FALSE         9404
#> 7            1996  FALSE            FALSE                        FALSE         9404
#> 8            1994  FALSE            FALSE                        FALSE         9404
#> 9            1990  FALSE            FALSE                        FALSE         9404
...
Search for assessments that recommend particular conservation actions
Get a list of all conservation actions
rl_actions()
#> $conservation_actions
#>                                              en  code
#> 1                         Land/water protection     1
#> 2                          Site/area protection   1_1
#> 3                 Resource & habitat protection   1_2
#> 4                         Land/water management     2
#> 5                          Site/area management   2_1
#> 6          Invasive/problematic species control   2_2
#> 7         Habitat & natural process restoration   2_3
#> 8                            Species management     3
...
Return assessments with a particular conservation action
rl_actions("2_2", all = FALSE)$assessments
#>     year_published latest possibly_extinct possibly_extinct_in_the_wild sis_taxon_id
#> 1             2019   TRUE            FALSE                        FALSE    132523146
#> 2             2019   TRUE            FALSE                        FALSE        10767
#> 3             2013   TRUE            FALSE                        FALSE         1078
#> 4             2019   TRUE            FALSE                        FALSE    132521900
#> 5             2020  FALSE            FALSE                        FALSE         1086
#> 6             2019   TRUE            FALSE                        FALSE         1117
#> 7             2019   TRUE            FALSE                        FALSE        11797
#> 8             2021   TRUE            FALSE                        FALSE        12124
#> 9             2019   TRUE            FALSE                        FALSE        12695
...

Logo

The rredlist logo showcases a silhouette of a Javan rhinoceros (Rhinoceros sondaicus), one of the most endangered mammal species on the planet. The species has suffered extreme population decline due to habitat loss and poaching, with only ~75 individuals alive in the wild today, all in Ujung Kulon National Park, a UNESCO World Heritage Site in Java, Indonesia. Despite recent conservation efforts, poaching continues; further, the small population is extremely susceptible to inbreeding, disease, and further habitat loss due to the rampant spreading of local palm trees. You can read more about the Javan rhino on the IUCN Red List, World Wildlife Fund, and International Rhino Foundation.

This work, "rredlist logo", is adapted from "Javan rhino silhouette" by Creazilla, used under CC BY 4.0. "rredlist logo" is licensed under CC BY 4.0 by William Gearty.

Meta

  • Please report any issues or bugs.
  • License: MIT
  • Get citation information for rredlist in R doing citation(package = 'rredlist')
  • Please note that this package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

rofooter

Help Manual

Help pageTopics
Conservation actions needed assessment summaryrl_actions rl_actions_
Get the Red List API versionrl_api_version
Retrieve an assessmentrl_assessment rl_assessment_
Red List category assessment summaryrl_categories rl_categories_
Get the citation for the Red List APIrl_citation
Class assessment summaryrl_class rl_class_
Comprehensive group assessment summaryrl_comp_groups rl_comp_groups_
Country assessment summaryrl_countries rl_countries_
Extinct taxa assessment summaryrl_extinct rl_extinct_
Extinct taxa in the wild assessment summaryrl_extinct_wild rl_extinct_wild_
Family assessment summaryrl_family rl_family_
FAO marine fishing region assessment summaryrl_faos rl_faos_
Green Status assessment summaryrl_green rl_green_
Growth form assessment summaryrl_growth_forms rl_growth_forms_
Habitat assessment summaryrl_habitats rl_habitats_
Kingdom assessment summaryrl_kingdom rl_kingdom_
Order assessment summaryrl_order rl_order_
Phylum assessment summaryrl_phylum rl_phylum_
Population trend assessment summaryrl_pop_trends rl_pop_trends_
Biogeographical realm assessment summaryrl_realms rl_realms_
Research needed assessment summaryrl_research rl_research_
Scope assessment summaryrl_scopes rl_scopes_
SIS ID assessment summaryrl_sis rl_sis_
SIS ID latest assessmentrl_sis_latest
Get count of species in the Red Listrl_sp_count rl_sp_count_
Species assessment summaryrl_species rl_species_
Species latest assessmentrl_species_latest
Stress assessment summaryrl_stresses rl_stresses_
System assessment summaryrl_systems rl_systems_
Threat assessment summaryrl_threats rl_threats_
Use and trade assessment summaryrl_use_and_trade rl_use_and_trade_
Helper to get and save IUCN API keyrl_key rl_use_iucn
Get the Red List versionrl_version
IUCN Red List color scalesscale_color_iucn scale_colour_iucn scale_discrete_iucn scale_fill_iucn