https://github.com/doi-usgs/sbtools

Tools for interfacing R with ScienceBase data services.
https://github.com/doi-usgs/sbtools

r r-package rstats sciencebase usgs

Last synced: 8 days ago
JSON representation

Tools for interfacing R with ScienceBase data services.

• Host: GitHub
• URL: https://github.com/doi-usgs/sbtools
• Owner: DOI-USGS
• License: cc0-1.0
• Created: 2014-12-08T18:09:06.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T20:23:01.000Z (5 months ago)
• Last Synced: 2024-06-11T19:16:19.033Z (5 months ago)
• Topics: r, r-package, rstats, sciencebase, usgs
• Language: R
• Homepage: http://doi-usgs.github.io/sbtools/
• Size: 5.49 MB
• Stars: 21
• Watchers: 8
• Forks: 21
• Open Issues: 23
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

ScienceBase R Tools

===

Tools for interfacing R with ScienceBase data services.

## Package Description

This package provides a rich interface to USGS's [ScienceBase](https://www.sciencebase.gov/), a data cataloging and collaborative data management platform. For further information, see the [sbtools manuscript in The R Journal](https://journal.r-project.org/archive/2016-1/winslow-chamberlain-appling-etal.pdf) (USGS IP-075498). See `citation('sbtools')` for how to cite the package.

### Recommended Citation:

```

  Winslow, LA, S Chamberlain, AP Appling, and JS Read. 2016. sbtools: 

  A package connecting R to cloud-based data for collaborative online 

  research. The R Journal 8:387-398.

```

Package source code DOI: https://doi.org/10.5066/P912NGFV

|Linux|Test Coverage|

|----------|------------|

| ![R-CMD-check](https://github.com/doi-usgs/sbtools/workflows/R-CMD-check/badge.svg) |[![codecov.io](https://codecov.io/github/DOI-USGS/sbtools/coverage.svg?branch=master)](https://app.codecov.io/github/DOI-USGS/sbtools?branch=master)|

### Current CRAN information

|Version|Monthly Downloads|Total Downloads|

|----------|------------|------------|

|[![CRAN version](https://www.r-pkg.org/badges/version/sbtools)](https://cran.r-project.org/package=sbtools)|[![](https://cranlogs.r-pkg.org/badges/sbtools)](https://cran.r-project.org/package=sbtools)|[![](https://cranlogs.r-pkg.org/badges/grand-total/sbtools)](https://cran.r-project.org/package=sbtools)|

## Package Installation

To install the `sbtools` package, you must be using R 3.0 or greater and run the following command:

```r

install.packages("sbtools")

```

To get cutting-edge changes, install from GitHub using the `devtools` packages:

```r

remotes::install_github("DOI-USGS/sbtools")

```

## Reporting bugs

Please consider reporting bugs and asking questions on the Issues page:

[https://github.com/DOI-USGS/sbtools/issues](https://github.com/DOI-USGS/sbtools/issues)

## Release Procedure

For release of the sbtools package, a number of steps are required.

1. Ensure all checks pass and code coverage is adequate.

1. Ensure `NEWS.md` reflects updates in version.

1. Update `DESCRIPTION` to reflect release version.

1. Convert `DISCLAIMER.md` to approved language and rebuild `README.Rmd`.

1. Create release candidate branch and commit release candidate.

1. Build source package and upload to CRAN.

1. Once accepted to CRAN, tag release candidate branch an push to repositories.

1. Change `DISCLAIMER.md` back to development mode and increment description version.

1. Merge release candidate and commit.

1. Open PR/MR in development state.

```{r disclaimer, child="DISCLAIMER.md", eval=TRUE}

```

 [

    ![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)

  ](https://creativecommons.org/publicdomain/zero/1.0/)