Data

Tools

Indexes

Applications

Experiments

Open Source Science

streamcattools

R package to work with the StreamCat API within R and access the full suite of StreamCat catchment and watershed scale metrics for all NHDPlusV2 stream reaches and catchments.

https://github.com/usepa/streamcattools

Science Score: 26.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
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.6%) to scientific vocabulary

Keywords

streamcat
Last synced: 11 months ago · JSON representation

Repository

R package to work with the StreamCat API within R and access the full suite of StreamCat catchment and watershed scale metrics for all NHDPlusV2 stream reaches and catchments.

Basic Info
Statistics
  • Stars: 35
  • Watchers: 11
  • Forks: 10
  • Open Issues: 15
  • Releases: 5
Topics
streamcat
Created over 6 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License

README.md

StreamCatTools

Project Status: Active – The project has reached a stable, usable state and is being actively developed. CRAN cran checks R-CMD-check Downloads <!-- badges: end -->

StreamCatTools: Tools to work with the StreamCat API within R and access the full suite of StreamCat and LakeCat metrics.

StreamCatTools is an R package for accessing StreamCat and LakeCat data via the StreamCat API and for working with site data in conjunction with StreamCat and NHDPlus.

Installation

Installation

You can install and load the most recent approved version from CRAN by running

```r

install the most recent approved version from CRAN

install.packages("StreamCatTools")

load the most recent approved version from CRAN

library(StreamCatTools) ``` You can install and load the most recent development version from GitHub by running:

r library(remotes) install_github("USEPA/StreamCatTools", build_vignettes=TRUE) library(StreamCatTools)

To view the vignettes in RStudio, run r vignette("Introduction", "StreamCatTools") vignette("Applications", "StreamCatTools") vignette("LakeCat", "StreamCatTools")

Contributing

Contributions to development of the package are welcome and encouraged. Please consider the following guidlelines for contributing to StreamCatTools:

  • We encourage package users to submit bugs and enhancement requests by submitting issues - see the Quickstart for GitHub Issues page if you are new to GitHub issues
  • Contributions should use the standard GitHub fork - pull-request workflow
  • We encourage use of the tidyverse style guide for contributions
  • Contributions should ideally be tested using testthat
  • Make sure you use roxygen and run Check before contributing
  • If you contribute to documentation, running devtools::document() and then pkgdown::build_site() will refresh the help docs and pkgdown pages (but do not push these packagedown changes - they are to verify changes locally)

Python Implementation of StreamCat API

PyNHD, part of the HyRiver suite of Python packages, also provides access to StreamCat data via the API in Python, along with other NHDPlus value-added attributes for catchments and catchment and network accumulated values for catchments available via USGS ScienceBase

Recommended Citation:

Weber, Marc H, Hill, Ryan A., Brookes, Allen F. 2024, StreamCatTools: Tools to work with the StreamCat API within R and access the full suite of StreamCat and LakeCat metrics, https://usepa.github.io/StreamCatTools

Disclaimer

The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity , confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.

Owner

  • Name: U.S. Environmental Protection Agency
  • Login: USEPA
  • Kind: organization
  • Location: United States of America

GitHub Events

Total
  • Create event: 8
  • Release event: 4
  • Issues event: 25
  • Watch event: 6
  • Delete event: 2
  • Member event: 1
  • Issue comment event: 21
  • Push event: 40
  • Pull request review event: 1
  • Pull request event: 9
  • Fork event: 5
Last Year
  • Create event: 8
  • Release event: 4
  • Issues event: 25
  • Watch event: 6
  • Delete event: 2
  • Member event: 1
  • Issue comment event: 21
  • Push event: 40
  • Pull request review event: 1
  • Pull request event: 9
  • Fork event: 5

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 154
  • Total Committers: 5
  • Avg Commits per committer: 30.8
  • Development Distribution Score (DDS): 0.104
Past Year
  • Commits: 35
  • Committers: 3
  • Avg Commits per committer: 11.667
  • Development Distribution Score (DDS): 0.229
Top Committers
Name Email Commits
Marc H. Weber m****6@g****m 138
zsmith27 z****2@d****v 6
EmmaVJones e****s@i****m 4
Justin Bousquin b****n@e****v 4
Weber w****c@e****v 2
Committer Domains (Top 20 + Academic)
epa.gov: 2 dec.ny.gov: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 43
  • Total pull requests: 37
  • Average time to close issues: 3 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 11
  • Total pull request authors: 4
  • Average comments per issue: 0.74
  • Average comments per pull request: 0.38
  • Merged pull requests: 34
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 18
  • Pull requests: 10
  • Average time to close issues: 2 months
  • Average time to close pull requests: about 7 hours
  • Issue authors: 7
  • Pull request authors: 2
  • Average comments per issue: 0.78
  • Average comments per pull request: 0.5
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mhweber (19)
  • ryan-hill (13)
  • michaeldumelle (3)
  • AnuPal1Hydro123 (1)
  • raphaelmazor (1)
  • mwiecksosa (1)
  • darinkopp (1)
  • jbeaulie (1)
  • daauerbach (1)
  • TravisPritchardODEQ (1)
  • rmcminds (1)
Pull Request Authors
  • mhweber (33)
  • rmcminds (2)
  • zsmith27 (1)
  • jbousquin (1)
Top Labels
Issue Labels
enhancement (10) bug (6) documentation (1) Package Management (1)
Pull Request Labels
enhancement (6) bug (2)

Packages

  • Total packages: 1
  • Total downloads:
    • cran 39 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
cran.r-project.org: StreamCatTools

StreamCat Tools

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 39 Last month
Rankings
Forks count: 6.7%
Stargazers count: 8.6%
Dependent packages count: 25.6%
Dependent repos count: 31.5%
Average: 31.5%
Downloads: 85.3%
Maintainers (1)
weber.marc@epa.gov
Last synced: 11 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5.1 depends
  • dplyr * imports
  • httr * imports
  • jsonlite * imports
  • magrittr * imports
  • nhdplusTools * imports
  • readr * imports
  • sf * imports
  • tidyr * imports
  • xml2 * imports
  • devtools * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite