rtaxonworks

R client for TaxonWorks

https://github.com/speciesfilegroup/rtaxonworks

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 1 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

R client for TaxonWorks

Basic Info
  • Host: GitHub
  • Owner: SpeciesFileGroup
  • License: mit
  • Language: R
  • Default Branch: main
  • Homepage:
  • Size: 313 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 1
  • Releases: 1
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Codemeta

README.Rmd

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).

Owner

  • Name: Species File Group
  • Login: SpeciesFileGroup
  • Kind: organization
  • Location: University of Illinois, INHS

A biodiversity informatics research group.

CodeMeta (codemeta.json)

{
  "@context": [
    "https://doi.org/10.5063/schema/codemeta-2.0",
    "http://schema.org"
  ],
  "@type": "SoftwareSourceCode",
  "identifier": "rtaxonworks",
  "description": "Client for TaxonWorks\n    (<https://www.taxonworks.org/>); a web application for managing biodiversity data, in particular taxonomic data. TaxonWorks is a Rails application, and this package provides an R interface to the TaxonWorks API.",
  "name": "rtaxonworks: TaxonWorks Client",
  "codeRepository": "https://github.com/SpeciesFileGroup/rtaxonworks",
  "relatedLink": "https://api.taxonworks.org",
  "issueTracker": "https://github.com/SpeciesFileGroup/rtaxonworks/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.0.1",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.1.0 (2021-05-18)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Geoff",
      "familyName": "Ower",
      "email": "gdower@illinois.edu",
      "@id": "https://orcid.org/0000-0002-9770-2345"
    }
  ],
  "contributor": {},
  "copyrightHolder": {},
  "funder": [
    {
      "@type": "Organization",
      "name": "Species File Group, Illinois Natural History Survey, Prairie Research Institute, University of Illinois"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Geoff",
      "familyName": "Ower",
      "email": "gdower@illinois.edu",
      "@id": "https://orcid.org/0000-0002-9770-2345"
    }
  ],
  "softwareSuggestions": [
    {
      "@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",
      "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"
    }
  ],
  "softwareRequirements": [
    {
      "@type": "SoftwareApplication",
      "identifier": "httr2",
      "name": "httr2",
      "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=httr2"
    },
    {
      "@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": "jsonlite",
      "name": "jsonlite",
      "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"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "data.table",
      "name": "data.table",
      "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=data.table"
    }
  ],
  "applicationCategory": "Biology",
  "isPartOf": "https://taxonworks.org",
  "keywords": [
    "biology",
    "science",
    "API",
    "web",
    "api-client",
    "taxonomy",
    "species",
    "rstats",
    "r"
  ],
  "releaseNotes": "https://github.com/SpeciesFileGroup/rtaxonworks/blob/master/NEWS.md",
  "readme": "https://github.com/SpeciesFileGroup/rtaxonworks/blob/master/README.md",
  "fileSize": "212.515KB",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "developmentStatus": "https://www.repostatus.org/#active"
}

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 39
  • Total Committers: 1
  • Avg Commits per committer: 39.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 14
  • Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Geoff Ower g****r@i****u 39
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 6
  • Total pull requests: 1
  • Average time to close issues: 29 days
  • Average time to close pull requests: about 4 hours
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.83
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 0
  • Average time to close issues: 13 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.33
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • gdower (3)
  • bonushenricus (3)
Pull Request Authors
  • gdower (1)
Top Labels
Issue Labels
bug (2) enhancement (1)
Pull Request Labels

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v4 composite
  • actions/upload-artifact v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
DESCRIPTION cran
  • data.table * imports
  • httr2 * imports
  • jsonlite * imports
  • tibble * imports
  • testthat * suggests
  • vcr * suggests
check/rtaxonworks.Rcheck/00_pkg_src/rtaxonworks/DESCRIPTION cran
  • data.table * imports
  • httr2 * imports
  • jsonlite * imports
  • tibble * imports
  • testthat * suggests
  • vcr * suggests
check/rtaxonworks.Rcheck/rtaxonworks/DESCRIPTION cran
  • data.table * imports
  • httr2 * imports
  • jsonlite * imports
  • tibble * imports
  • testthat * suggests
  • vcr * suggests