ropensci/rredlistPublic

NotificationsYou must be signed in to change notification settings
Fork17
Star61

IUCN Red List API Client

License

Unknown, MIT licenses found

Licenses found

61 stars 17 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 199 Commits
.github		.github
R		R
inst		inst
man-roxygen		man-roxygen
man		man
revdep		revdep
tests		tests
vignettes		vignettes
.Rbuildignore		.Rbuildignore
.gitattributes		.gitattributes
.gitignore		.gitignore
.zenodo.json		.zenodo.json
CONTRIBUTING.md		CONTRIBUTING.md
DESCRIPTION		DESCRIPTION
LICENSE		LICENSE
LICENSE.md		LICENSE.md
Makefile		Makefile
NAMESPACE		NAMESPACE
NEWS.md		NEWS.md
README.Rmd		README.Rmd
README.md		README.md
_pkgdown.yml		_pkgdown.yml
codemeta.json		codemeta.json
cran-comments.md		cran-comments.md

Repository files navigation

rredlist

rredlist is an R client for the IUCN Red List API (https://api.iucnredlist.org). TheIUCN 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 documentedhere.

Installation

CRAN

install.packages("rredlist")

Development version

remotes::install_github("ropensci/rredlist")# ORinstall.packages("rredlist",repos="https://ropensci.r-universe.dev/")

Authentication

Use of this package requires an IUCN API key which can be acquired athttps://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  FALSE            FALSE                        FALSE        11797#> 8            2021   TRUE            FALSE                        FALSE        12124#> 9            2025   TRUE            FALSE                        FALSE    232775771...

Logo

Therredlist logo showcases a silhouette of aJavan 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, aUNESCO 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 theIUCN Red List,World Wildlife Fund, andInternational Rhino Foundation.

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

Contributors

All contributions to this project are gratefully acknowledged using theallcontributors package following theallcontributors specification. Contributions of any kind are welcome!

Code

Issue Authors

stevenpbachman	FVFaleiro	git-og	arw36	electricquad	bgerstner90	lime-n
marcelxelo	cpavloud	Gopal-Murali	DanielIAvila	michitobler	martijnvandepol	XuWeiEvo
makosiaaa	wk-ai	Lisa-Tedeschi	oldenfish	laetitiatremblay

Issue Contributors

olliewearn	matthewlewis896	mairindeith	MirzaCengic	rdornas	awpark	ingomiller
yabellini	benscarlson	mcauchoix	magpiedin	klausriede	simon-tarr	ToleranceTrading
omerome83	Crastoman	karolazvdo	Andresmrv3	jzhongwen	malmagrok	nicholasZ16
dcuadrac