Data

Tools

Indexes

Applications

Experiments

Open Source Science

rredlist

IUCN Red List API Client

https://github.com/ropensci/rredlist

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary

Keywords

api-wrapper biodiversity conservation iucn iucn-red-list r r-package rstats taxize

Keywords from Contributors

genome http-mock mock database-retrieval air-pollution turfjs turf geojson ensembl-servers genome-annotation
Last synced: 4 months ago · JSON representation

Repository

IUCN Red List API Client

Basic Info
Statistics
  • Stars: 59
  • Watchers: 8
  • Forks: 16
  • Open Issues: 3
  • Releases: 10
Topics
api-wrapper biodiversity conservation iucn iucn-red-list r r-package rstats taxize
Created almost 10 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Codemeta

README.Rmd 

# rredlist 

```{r echo=FALSE}
library("knitr")
library("rredlist")
hook_output <- knitr::knit_hooks$get("output")
knitr::knit_hooks$set(output = function(x, options) {
   lines <- options$output.lines
   if (is.null(lines)) {
     return(hook_output(x, options))  # pass to default hook
   }
   x <- unlist(strsplit(x, "\n"))
   more <- "..."
   if (length(lines)==1) {        # first n lines
     if (length(x) > lines) {
       # truncate the output, but add ....
       x <- c(head(x, lines), more)
     }
   } else {
     x <- c(if (abs(lines[1])>1) more else NULL,
            x[lines],
            if (length(x)>lines[abs(length(lines))]) more else NULL
           )
   }
   # paste these lines together
   x <- paste(c(x, ""), collapse = "\n")
   hook_output(x, options)
 })

knitr::opts_chunk$set(
  warning = FALSE,
  message = FALSE,
  collapse = TRUE,
  comment = "#>"
)
```

[![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/663_status.svg)](https://github.com/ropensci/software-review/issues/663)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![cran version](https://www.r-pkg.org/badges/version/rredlist)](https://cran.r-project.org/package=rredlist)
[![R-check](https://github.com/ropensci/rredlist/actions/workflows/R-check.yml/badge.svg)](https://github.com/ropensci/rredlist/actions/workflows/R-check.yml)
[![codecov.io](https://codecov.io/gh/ropensci/rredlist/coverage.svg)](https://app.codecov.io/gh/ropensci/rredlist)
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/rredlist)](https://github.com/r-hub/cranlogs.app)

`rredlist` is an R client for the IUCN Red List API (https://api.iucnredlist.org). The [IUCN Red List](https://www.iucnredlist.org/) 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](https://api.iucnredlist.org/api-docs/index.html).

## Installation

CRAN

```{r eval=FALSE}
install.packages("rredlist")
```

Development version

```{r eval=FALSE}
remotes::install_github("ropensci/rredlist")
# 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:

```{r eval=FALSE}
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
```{r}
library("rredlist")
```

### Search for assessments for a particular species
```{r output.lines=1:10}
rl_species("Gorilla", "gorilla")$assessments
```

### Search for assessments that recommend particular conservation actions

#### Get a list of all conservation actions
```{r output.lines=1:10}
rl_actions()
```

#### Return assessments with a particular conservation action
```{r output.lines=1:10}
rl_actions("2_2", all = FALSE)$assessments
```

## Logo



The `rredlist` logo showcases a silhouette of a [Javan rhinoceros](https://www.iucnredlist.org/species/19495/18493900) (_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](https://whc.unesco.org/en/list/608) in Java, Indonesia. Despite recent conservation efforts, [poaching continues](https://www.savetherhino.org/asia/indonesia/poaching-gangs-claim-to-have-killed-one-third-of-the-remaining-javan-rhino-population/); 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](https://www.iucnredlist.org/species/19495/18493900), [World Wildlife Fund](https://www.worldwildlife.org/species/javan-rhino), and [International Rhino Foundation](https://rhinos.org/about-rhinos/rhino-species/javan-rhino/).

This work, "rredlist logo", is adapted from ["Javan rhino silhouette"](https://creazilla.com/media/silhouette/64313/javan-rhino) by [Creazilla](https://creazilla.com/), used under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). "rredlist logo" is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) by William Gearty.

## Meta

* Please [report any issues or bugs](https://github.com/ropensci/rredlist/issues).
* 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](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

[![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)

## Contributors






All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [allcontributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!

### Code











sckott






willgearty






maelle






jeffreyhanson






jeroen






KevCaz








### 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

Owner

  • Name: rOpenSci
  • Login: ropensci
  • Kind: organization
  • Email: info@ropensci.org
  • Location: Berkeley, CA

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "rredlist",
  "description": "'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.",
  "name": "rredlist: 'IUCN' Red List Client",
  "relatedLink": "https://docs.ropensci.org/rredlist/",
  "codeRepository": "https://github.com/ropensci/rredlist",
  "issueTracker": "https://github.com/ropensci/rredlist/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "1.1.1",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.1 (2025-06-13 ucrt)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "William",
      "familyName": "Gearty",
      "email": "willgearty@gmail.com",
      "@id": "https://orcid.org/0000-0003-0076-3262"
    },
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Chamberlain",
      "email": "myrmecocystus@gmail.com",
      "@id": "https://orcid.org/0000-0003-1444-9135"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Malle",
      "familyName": "Salmon",
      "email": "maelle.salmon@yahoo.se",
      "@id": "https://orcid.org/0000-0002-2815-0399"
    }
  ],
  "funder": [
    {
      "@type": "Organization",
      "name": "rOpenSci"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "William",
      "familyName": "Gearty",
      "email": "willgearty@gmail.com",
      "@id": "https://orcid.org/0000-0003-0076-3262"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "spelling",
      "name": "spelling",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=spelling"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "vcr",
      "name": "vcr",
      "version": ">= 0.6.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=vcr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "webmockr",
      "name": "webmockr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=webmockr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "microbenchmark",
      "name": "microbenchmark",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=microbenchmark"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "ggplot2",
      "name": "ggplot2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dplyr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "tibble",
      "name": "tibble",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tibble"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "tidyr",
      "name": "tidyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tidyr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "patchwork",
      "name": "patchwork",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=patchwork"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "vdiffr",
      "name": "vdiffr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=vdiffr"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "crul",
      "name": "crul",
      "version": ">= 0.3.8",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=crul"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "jsonlite",
      "name": "jsonlite",
      "version": ">= 1.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jsonlite"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "lifecycle",
      "name": "lifecycle",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=lifecycle"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "curl",
      "name": "curl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=curl"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "rlang",
      "name": "rlang",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rlang"
    },
    "SystemRequirements": null
  },
  "applicationCategory": "Biodiversity",
  "isPartOf": "https://ropensci.org",
  "keywords": [
    "IUCN",
    "biodiversity",
    "API",
    "web-services",
    "traits",
    "habitat",
    "species",
    "conservation",
    "api-wrapper",
    "rstats",
    "iucn-red-list",
    "iucn",
    "r",
    "r-package",
    "taxize"
  ],
  "fileSize": "6918.991KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2025",
      "author": [
        {
          "@type": "Person",
          "givenName": "William",
          "familyName": "Gearty"
        },
        {
          "@type": "Person",
          "givenName": "Scott",
          "familyName": "Chamberlain"
        }
      ],
      "name": "rredlist: 'IUCN' Red List Client",
      "identifier": "10.32614/CRAN.package.rredlist",
      "url": "https://docs.ropensci.org/rredlist/",
      "description": "R package version 1.1.1",
      "@id": "https://doi.org/10.32614/CRAN.package.rredlist",
      "sameAs": "https://doi.org/10.32614/CRAN.package.rredlist"
    }
  ],
  "releaseNotes": "https://github.com/ropensci/rredlist/blob/main/NEWS.md",
  "readme": "https://github.com/ropensci/rredlist/blob/main/README.md",
  "contIntegration": [
    "https://github.com/ropensci/rredlist/actions/workflows/R-check.yml",
    "https://app.codecov.io/gh/ropensci/rredlist"
  ],
  "developmentStatus": "https://www.repostatus.org/#active",
  "review": {
    "@type": "Review",
    "url": "https://github.com/ropensci/software-review/issues/663",
    "provider": "https://ropensci.org"
  }
}

GitHub Events

Total
  • Create event: 5
  • Release event: 2
  • Issues event: 27
  • Watch event: 7
  • Delete event: 1
  • Issue comment event: 49
  • Push event: 58
  • Pull request review event: 1
  • Pull request event: 11
  • Fork event: 4
Last Year
  • Create event: 5
  • Release event: 2
  • Issues event: 27
  • Watch event: 7
  • Delete event: 1
  • Issue comment event: 49
  • Push event: 58
  • Pull request review event: 1
  • Pull request event: 11
  • Fork event: 4

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 185
  • Total Committers: 7
  • Avg Commits per committer: 26.429
  • Development Distribution Score (DDS): 0.357
Past Year
  • Commits: 47
  • Committers: 4
  • Avg Commits per committer: 11.75
  • Development Distribution Score (DDS): 0.064
Top Committers
Name Email Commits
Scott Chamberlain m****s@g****m 119
William Gearty w****y@g****m 49
Maëlle Salmon m****n@y****e 13
Kevin Cazelles k****s@i****o 1
Jeroen Ooms j****s@g****m 1
Jeff Hanson j****n@u****u 1
rOpenSci Bot m****t@g****m 1
Committer Domains (Top 20 + Academic)
uqconnect.edu.au: 1 insileco.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 68
  • Total pull requests: 19
  • Average time to close issues: 7 months
  • Average time to close pull requests: 29 days
  • Total issue authors: 24
  • Total pull request authors: 6
  • Average comments per issue: 2.82
  • Average comments per pull request: 2.95
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 18
  • Pull requests: 13
  • Average time to close issues: 8 days
  • Average time to close pull requests: 18 days
  • Issue authors: 11
  • Pull request authors: 3
  • Average comments per issue: 1.94
  • Average comments per pull request: 2.46
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • sckott (29)
  • willgearty (7)
  • maelle (6)
  • arw36 (4)
  • stevenpbachman (2)
  • laetitiatremblay (2)
  • michitobler (1)
  • lime-n (1)
  • Lisa-Tedeschi (1)
  • DanDAM16 (1)
  • DanielIAvila (1)
  • electricquad (1)
  • martijnvandepol (1)
  • cpavloud (1)
  • FVFaleiro (1)
Pull Request Authors
  • willgearty (7)
  • KevCaz (4)
  • maelle (3)
  • jeffreyhanson (2)
  • sckott (2)
  • arw36 (1)
Top Labels
Issue Labels
bug (3) enhancement (2) help wanted (1)
Pull Request Labels
work in progress (3) enhancement (3) api update (2)

Packages

  • Total packages: 3
  • Total downloads:
    • cran 6,686 last-month
  • Total docker downloads: 200,502
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 5
    (may contain duplicates)
  • Total versions: 26
  • Total maintainers: 1
proxy.golang.org: github.com/ropensci/rredlist
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
cran.r-project.org: rredlist

'IUCN' Red List Client

  • Versions: 11
  • Dependent Packages: 1
  • Dependent Repositories: 5
  • Downloads: 6,686 Last month
  • Docker Downloads: 200,502
Rankings
Downloads: 7.6%
Dependent repos count: 13.1%
Average: 15.8%
Dependent packages count: 18.2%
Docker downloads count: 24.2%
Maintainers (1)
willgearty@gmail.com
Last synced: 4 months ago
conda-forge.org: r-rredlist
  • Versions: 5
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent packages count: 28.8%
Dependent repos count: 34.0%
Average: 35.6%
Forks count: 39.0%
Stargazers count: 40.5%
Last synced: 4 months ago

Dependencies

DESCRIPTION cran
  • crul >= 0.3.8 imports
  • jsonlite >= 1.1 imports
  • testthat * suggests
  • vcr >= 0.4.0 suggests
.github/workflows/R-check.yml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/lint.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/revdepcheck.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite