Data

Tools

Indexes

Applications

Experiments

Open Source Science

tidywater

https://github.com/brownandcaldwell-public/tidywater

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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (18.4%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: BrownandCaldwell-Public
  • License: other
  • Language: R
  • Default Branch: main
  • Size: 671 KB
Statistics
  • Stars: 13
  • Watchers: 4
  • Forks: 4
  • Open Issues: 4
  • Releases: 6
Created over 1 year ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Codeowners Security Governance

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-"
)
```

# tidywater 


[![R-CMD-check](https://github.com/BrownandCaldwell-Public/tidywater/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/BrownandCaldwell-Public/tidywater/actions/workflows/R-CMD-check.yaml)


## Overview 

Tidywater incorporates published water chemistry and empirical models in a standard format.
The modular functions allow for building custom, comprehensive drinking water treatment processes. 
Functions are designed to work in a [tidyverse](https://www.tidyverse.org/) workflow. 

## Installation


``` r
# Install tidywater from CRAN:
install.packages("tidywater")

# Alternatively, install the development version from GitHub:
# install.packages("devtools")
devtools::install_github("BrownandCaldwell-Public/tidywater")
```

## Examples

In this first example, acid-base chemistry and TOC removal models are demonstrated. This example 
uses tidywater base functions to model a single water quality scenario.

```{r example, message = FALSE, setup = TRUE}
library(tidywater)
library(tidyverse)
## Use base tidywater functions to model water quality for a single scenario.
base_coagulation <- define_water(ph = 8, alk = 90, tds = 50, toc = 3, doc = 2.8, uv254 = 0.08) %>%
  chemdose_ph(alum = 30) %>%
  chemdose_toc(alum = 30)
```

To model multiple water quality scenarios, use tidywater's helper functions (x_chain or x_once) to 
apply the models to a dataframe.

```{r}
## x_chain functions apply models to a list of "waters", and output a list of "waters" so that
## the data can be piped into the next tidywater model.
coagulation <- water_df %>%
  define_water_chain(output_water = "raw") %>%
  mutate(alum = 30) %>%
  chemdose_ph_chain(input_water = "raw", output_water = "phchange") %>%
  chemdose_toc_chain(input_water = "phchange", output_water = "coag")

## To get out individual parameters, use `pluck_water`
coagulation <- coagulation %>%
  pluck_water(input_waters = c("raw", "coag"), parameter = c("ph", "doc"))
```

Note that these functions use a "water" class. The "water" class is the foundation of the package; 
it provides a mechanism for linking models in any order while maintaining water quality information.
The `define_water` function takes water quality inputs, but `define_water_chain` may be used to convert
a dataframe to a list of "waters".

For more detailed examples on tidywater functions and how to use "water" class data, please see 
the tidywater vignettes: `browseVignettes("tidywater")`

## Limitations
This project is maintained by volunteers and is provided without warranties or guarantees of any kind.  

Use at your own risk. For official support, please contact Brown and Caldwell. 

Please read our CONTRIBUTING.md and SECURITY.md before submitting issues or pull requests.

Owner

  • Name: Brown and Caldwell - Public
  • Login: BrownandCaldwell-Public
  • Kind: organization
  • Email: kchambers@brwncald.com
  • Location: United States of America

GitHub Events

Total
  • Create event: 5
  • Release event: 6
  • Issues event: 5
  • Watch event: 14
  • Delete event: 4
  • Issue comment event: 8
  • Push event: 9
  • Pull request review comment event: 4
  • Gollum event: 3
  • Pull request review event: 20
  • Pull request event: 19
  • Fork event: 3
Last Year
  • Create event: 5
  • Release event: 6
  • Issues event: 5
  • Watch event: 14
  • Delete event: 4
  • Issue comment event: 8
  • Push event: 9
  • Pull request review comment event: 4
  • Gollum event: 3
  • Pull request review event: 20
  • Pull request event: 19
  • Fork event: 3

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 1
  • Total pull requests: 7
  • Average time to close issues: 9 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.29
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 7
  • Average time to close issues: 9 months
  • Average time to close pull requests: 2 months
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.29
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • Carter12s (2)
Pull Request Authors
  • sierrajohnson (7)
  • Carter12s (2)
  • csomerlot (2)
  • libbymckenna (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 235 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
cran.r-project.org: tidywater

Water Quality Models for Drinking Water Treatment Processes

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 235 Last month
Rankings
Dependent packages count: 27.8%
Dependent repos count: 34.3%
Average: 49.7%
Downloads: 87.0%
Maintainers (1)
sjohnson2@brwncald.com
Last synced: 7 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 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
.github/workflows/dependencies-scan.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/gitleaks.yaml actions
  • actions/checkout v4 composite
  • gitleaks/gitleaks-action v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 2.10 depends
  • dplyr * imports
  • furrr * imports
  • ggplot2 * imports
  • ggrepel * imports
  • knitr * imports
  • magrittr * imports
  • methods * imports
  • purrr * imports
  • rlang * imports
  • tidyr * imports
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests