README.Rmd

worrms
======

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

<!-- README.md is generated from README.Rmd. Please edit that file -->

[![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)
[![R-check](https://github.com/ropensci/worrms/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/worrms/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/ropensci/worrms/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ropensci/worrms)
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/worrms)](https://github.com/r-hub/cranlogs.app)
[![cran version](https://www.r-pkg.org/badges/version/worrms)](https://cran.r-project.org/package=worrms)
[![cran checks](https://badges.cranchecks.info/worst/worrms.svg)](https://cran.r-project.org/web/checks/check_results_worrms.html)

`worrms` is a R client for the World Register of Marine Species

* World Register of Marine Species (WoRMS) https://www.marinespecies.org/
* WoRMS REST API docs: https://www.marinespecies.org/rest/

See the taxize book (https://taxize.dev) for taxonomically focused work
in this and similar packages.

## Installation

More stable CRAN version

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

Development version

```{r eval=FALSE}
remotes::install_github("ropensci/worrms")
```

```{r}
library("worrms")
```

## Meta

* Please [report any issues or bugs](https://github.com/ropensci/worrms/issues).
* License: MIT
* Get citation information for `worrms` in R doing `citation(package = 'worrms')`
* 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)