tidywater

0.10.0

Water Quality Models for Drinking Water Treatment Processes

0packages depend

2.6Kdownloads / year

94.9%test coverage

13/13checks pass

Overview

About

Maintained by Sierra JohnsonFirst published 2024-11-055 releasesCRAN page ↗GitHub ↗

Provides multiple water chemistry-based models and published empirical models in one standard format. As many models have been included as possible, however, users should be aware that models have varying degrees of accuracy and applicability. To learn more, read the references provided below for the models implemented. Functions can be chained together to model a complete treatment process and are designed to work in a 'tidyverse' workflow. Models are primarily based on these sources: Benjamin, M. M. (2002, ISBN:147862308X), Crittenden, J. C., Trussell, R., Hand, D., Howe, J. K., & Tchobanoglous, G., Borchardt, J. H. (2012, ISBN:9781118131473), USEPA. (2001) https://www.epa.gov/sites/default/files/2017-03/documents/wtp_model_v._2.0_manual_508.pdf.

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("tidywater", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("BrownandCaldwell-Public/tidywater")

Development version from BrownandCaldwell-Public/tidywater. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-tidywater

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-tidywater

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-tidywater

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 6.9 min · r-devel-linux-x86_64-fedora-clang

Code health

Yes

Tests · ratio 0.69

94.9%

Coverage · measured lines

99%

Documentation · exports

Dependencies · direct

Check history

OK2026-06-09
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-06-07
12 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 228 wordsVignettesYes · dynamicpkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

Examples that run: 93%
Documented parameters: 98%
Return-value docs: 98%
References docs: 0%

Downloads

2.6K

CRAN downloads in the past year

Rank #19,067 · ~7/day · ~219/mo

Releases R versions

Daily download trend is not available in this view yet.

18930 days

59990 days

2.6K1 year

Compare downloads with other packages →

Also on115 r2u29 autocran

Repository

GitHub ↗ brownandcaldwell-public/tidywater

21Stars

4Forks

6Open issues

2Open PRs

9Releases

1,821Commits

18Contributors

chemistrywaterdrinking-waterr-programmingtidyverse

1,821 commits · Last activity 2026-07-17 · 0% stars, 30d

Stars over time

2025-07-02 · 112026-07-07 · 21

Repository practices

Upstream repositoryBeta

10 development-tooling and community-health practices detected across 6 families in the upstream repository

Checks run against github.com/brownandcaldwell-public/tidywater on 2026-07-26.

Continuous integration (1)

GitHub Actions

Reproducibility and dev environment (1)

data-raw/

CRAN release process (1)

cran-comments.md

Docs source (1)

README.Rmd

Show all practices

Lint, format, editor (2)

AirRStudio project

Governance and community (4)

Issue templatesSecurity policyCODEOWNERSGovernance doc

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

13 external dependencies (excludes base and recommended)

Depends (1)

R >= 4.1

Imports (11)

dplyr tidyr forcats knitr ggplot2 ggrepel magrittrmethodsrlang deSolve lifecycle

LinkingTo (0)

none

Suggests (3)

rmarkdown purrr testthat

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Datasets

People & History

People (10)

Maintainer (1)

Sierra Johnson

Author, Maintainer

Authors (4)

Author, Maintainer

Author

Author

Author

Contributors (4)

Phoebe Chen

Contributor · added in 0.7.0

Rachel Merrifield

Contributor

Mayuri Namasivayam

Contributor

Jiaming Yuan

Contributor · added in 0.9.0

Brown and Caldwell

Funder, Copyright holder

USEPA

Funders (1)

Brown and Caldwell

Funder, Copyright holder

Package Timeline

5 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
0.10.0Latest
2025-08-24 · current release · diff ↗
0.9.0
2025-07-03 · diff ↗
0.8.2
2025-05-17 · diff ↗
R
R 4.5.0 released · 2025-04-11
0.7.0
2025-01-23 · diff ↗
0.6.2
2024-11-05
R
R 4.4.0 released · 2024-04-24

Package metadata

First published: 2024-11-05
Total releases: 5 / 2 yrs
License: Apache License (>= 2) | MIT + file LICENSE OSI
Minimum R: ≥ 4.1
Bundled data: 8.4 KB / 13 files
Download size: 327 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →