https://github.com/speciesfilegroup/rtaxonworks

R client for TaxonWorks
https://github.com/speciesfilegroup/rtaxonworks

Last synced: 5 months ago
JSON representation

R client for TaxonWorks

• Host: GitHub
• URL: https://github.com/speciesfilegroup/rtaxonworks
• Owner: SpeciesFileGroup
• License: mit
• Created: 2024-02-12T20:50:00.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T16:03:15.000Z (over 1 year ago)
• Last Synced: 2025-09-04T20:58:42.436Z (10 months ago)
• Language: R
• Homepage:
• Size: 313 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codemeta: codemeta.json

Awesome Lists containing this project

README

          
rtaxonworks

====

```{r echo=FALSE}

knitr::opts_chunk$set(

  comment = "#>",

  collapse = TRUE,

  warning = FALSE,

  message = FALSE

)

```

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![R-CMD-check](https://github.com/SpeciesFileGroup/rtaxonworks/workflows/R-CMD-check/badge.svg)](https://github.com/SpeciesFileGroup/rtaxonworks/actions)

[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/rtaxonworks)](https://github.com/r-hub/cranlogs.app)

[![cran version](https://www.r-pkg.org/badges/version/rtaxonworks)](https://cran.r-project.org/package=rtaxonworks)

`rtaxonworks` is an R client for the [TaxonWorks](https://taxonworks.org) API. Code follow the spirit/approach of the Gem [rcol](https://github.com/sckott/rcol), and indeed much of the wrapping utility is copied 1:1 from that repo, thanks [@sckott](https://github.com/sckott).

Package documentation: https://docs.taxonworks.org/r

* TaxonWorks: https://taxonworks.org

* TaxonWorks GitHub repository: https://github.com/SpeciesFileGroup/taxonworks

* TaxonWorks API docs: https://api.taxonworks.org

* TaxonWorks documentation: https://docs.taxonworks.org

## Installation

```{r eval=FALSE}

install.packages("rtaxonworks")

```

Install the development version from GitHub with:

```{r eval=FALSE} 

install.packages("remotes")

remotes::install_github("SpeciesFileGroup/rtaxonworks")

```

Load the package

```{r eval=FALSE}

library("rtaxonworks")

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/SpeciesFileGroup/rtaxonworks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/SpeciesFileGroup/rtaxonworks/blob/main/CODE_OF_CONDUCT.md).

## Development

Please read the [CONTRIBUTING guide](CONTRIBUTING.md) for instructions on how to install the development version.

## License

The gem is available as open source under the terms of the [MIT license](https://github.com/SpeciesFileGroup/rtaxonworks/blob/main/LICENSE.txt). You can learn more about the MIT license on [Wikipedia](https://en.wikipedia.org/wiki/MIT_License) and compare it with other open source licenses at the [Open Source Initiative](https://opensource.org/license/mit/).

## Code of Conduct

Everyone interacting in the rtaxonworks project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SpeciesFileGroup/rtaxonworks/blob/main/CODE_OF_CONDUCT.md).