Data

Tools

Indexes

Applications

Experiments

Open Source Science

MassWateR

R package for working with Massachusetts surface water quality data

https://github.com/massbays-tech/masswater

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
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

package
Last synced: 6 months ago · JSON representation

Repository

R package for working with Massachusetts surface water quality data

Basic Info
Statistics
  • Stars: 13
  • Watchers: 3
  • Forks: 3
  • Open Issues: 0
  • Releases: 9
Topics
package
Created almost 4 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.md

MassWateR

R-CMD-check pkgdown Codecov test coverage CRAN status <!-- badges: end -->

R package for working with Massachusetts surface water quality data, created in partnership by the Mass Bays National Estuary Partnership.

Please cite the package as:

Beck, M.W., Wetherill, B., Carr, J. 2023. MassWateR: Improving Quality Control, Analysis, and Sharing of Water Quality Data. PLOS ONE. 18(11):e0293737. doi: 10.1371/journal.pone.0293737

Installation

The package can be installed as follows:

``` r

Install the package

install.packages("MassWateR") ```

Windows PC users may encounter the following warning when installing MassWateR.

r WARNING: Rtools is required to build R packages but is not currently installed. Please download and install the appropriate version of Rtools before proceeding: https://cran.r-project.org/bin/windows/Rtools/

This warning can be ignored for the MassWateR solution. If desired, RTools can be obtained following the instructions here.

Using the package

Please see the vignette articles for an overview of how to use functions in the MassWateR package. The vignettes are organized topically as follows:

  • MassWateR quick start: A quick start guide to importing data and using the various functions in MassWateR. Detailed information is provided in the other vignettes.
  • MassWateR data input and checks: Information on datasets required to use the package, the required formats and how to import them into R, and the checks that are run when the data are imported.
  • MassWateR outlier checks: Information on evaluating outliers in the results data for surface water quality.
  • MassWateR quality control functions: Information on using the quality control functions to assess completeness and accuracy of results data for surface water quality and to generate automated reports.
  • MassWateR analysis functions: Information on using the analysis functions to evaluate trends, summaries, and maps in the results data for surface water quality.
  • MassWateR utility functions: Information on using optional utility functions for custom analyses.
  • Modifying plots: A short tutorial on modifying plots created with MassWateR.
  • Water Quality Exchange output: Information on generating output that will facilitate upload of data to the EPA Water Quality Exchange
  • Out of state?: MassWateR can be used anywhere and this article describes some tips for using the package outside of Massachusetts.

In addition to the content on this web page, the MassWateR Community of Practice forum is a space for users to find help, share ideas, and suggest improvements for the package. Please follow the link to register and login to the forum.

Issues and help

Please report any issues (bugs or errors) on the issues link for the repository. Please visit the Community of Practice forum for general questions, help, sharing ideas, or to suggest package improvements.

Contributing

Please view our contributing guidelines for any changes or pull requests.

Code of Conduct

Please note that the MassWateR project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Owner

  • Name: Massachusetts Bays National Estuary Partnership
  • Login: massbays-tech
  • Kind: organization
  • Email: Jillian.Carr@umb.edu
  • Location: United States of America

Group page for the Massachusetts Bays National Estuary Partnership

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 9
  • Push event: 72
  • Pull request event: 2
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 9
  • Push event: 72
  • Pull request event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 553
  • Total Committers: 3
  • Avg Commits per committer: 184.333
  • Development Distribution Score (DDS): 0.065
Top Committers
Name Email Commits
fawda123 m****2@g****m 517
Ben Wetherill 1****l@u****m 34
GitHub Actions a****s@g****m 2
Committer Domains (Top 20 + Academic)
github.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 70
  • Total pull requests: 1
  • Average time to close issues: 24 days
  • Average time to close pull requests: 1 minute
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 3.81
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 1
  • Average time to close issues: 8 days
  • Average time to close pull requests: 1 minute
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 2.25
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ben-wetherill (37)
  • fawda123 (33)
Pull Request Authors
  • fawda123 (1)
Top Labels
Issue Labels
quality control (15) checks (9) bug (6) documentation (5) analysis (5) reporting format (5) wqx upload (4) enhancement (4) formatting (4) question (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 741 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 10
  • Total maintainers: 1
cran.r-project.org: MassWateR

Quality Control and Analysis of Massachusetts Water Quality Data

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 741 Last month
Rankings
Stargazers count: 21.1%
Forks count: 21.9%
Average: 27.7%
Dependent packages count: 29.8%
Downloads: 30.1%
Dependent repos count: 35.5%
Maintainers (1)
mbeck@tbep.org
Last synced: 6 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • r-lib/actions/setup-tinytex v2 composite
.github/workflows/parambuild.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • r-lib/actions/setup-tinytex v2 composite
DESCRIPTION cran
  • R >= 3.5 depends
  • RColorBrewer * imports
  • curl * imports
  • dplyr * imports
  • flextable * imports
  • ggplot2 * imports
  • ggrepel * imports
  • ggspatial * imports
  • httr * imports
  • lubridate * imports
  • prettymapr * imports
  • raster * imports
  • readxl * imports
  • rmarkdown * imports
  • sf * imports
  • tibble * imports
  • tidyr * imports
  • units * imports
  • writexl * imports
  • covr * suggests
  • knitr * suggests
  • patchwork * suggests
  • testthat >= 3.0.0 suggests