R Observatory: Metrics for hydroState version 0.2.0.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

hydroState

0.2.0.0

Hidden Markov Modelling of Hydrological State Change

0packages depend

2.1Kdownloads / year

–test coverage

13/13checks pass

Overview

About

Maintained by Tim PetersonFirst published 2025-09-221 releasesCRAN page ↗GitHub ↗

Identifies regime changes in streamflow runoff not explained by variations in precipitation. The package builds a flexible set of Hidden Markov Models of annual, seasonal or monthly streamflow runoff with precipitation as a predictor. Suites of models can be built for a single site, ranging from one to three states and each with differing combinations of error models and auto-correlation terms. The most parsimonious model is easily identified by AIC, and useful for understanding catchment drought non-recovery: Peterson TJ, Saft M, Peel MC & John A (2021) doi:10.1126/science.abd5085.

Install

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

install.packages("hydroState", 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("peterson-tim-j/HydroState")

Development version from peterson-tim-j/HydroState. 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-hydrostate

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-hydroState

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-hydroState

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

Health

CRAN checks

13OK

Slowest check: 2.1 min · r-oldrel-windows-x86_64

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

9

Dependencies · direct

Check history

OK2026-08-05
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 589 wordsVignettesNopkgdown siteNoNEWSYes · 67% structuredCode of conductNoContributing guideNo

Examples that run: 100%
Documented parameters: 85%
Return-value docs: 100%
References docs: 0%

Downloads

2.1K

CRAN downloads in the past year

Rank #19,627 · ~6/day · ~172/mo

Releases R versions

Daily download trend is not available in this view yet.

16630 days

56490 days

2.1K1 year

Compare downloads with other packages →

Also on73 r2u3 autocran

Repository

GitHub ↗ peterson-tim-j/hydrostate

12Stars

9Forks

6Open issues

2Open PRs

1Releases

110Commits

4Contributors

hydrologystreamflowhidden-markov-modelstatistics

110 commits · Last activity 2026-08-19 · 0% stars, 30d

Stars over time

2024-05-16 · 102026-07-07 · 12

Repository practices

Upstream repositoryBeta

4 development-tooling and community-health practices detected across 3 families in the upstream repository

Checks run against github.com/peterson-tim-j/hydrostate on 2026-08-16.

Continuous integration (1)

GitHub Actions

CRAN release process (2)

cran-comments.mdCRAN-SUBMISSION

Lint, format, editor (1)

RStudio project

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

Dependencies

Declared dependencies

11 external dependencies (excludes base and recommended)

Depends (1)

R >= 3.5.0

Imports (9)

methodsDEoptim sn truncnorm diagram padr zoographicscheckmate

LinkingTo (0)

none

Suggests (4)

knitr rmarkdown testthat V8

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Datasets

People & History

People (2)

Maintainer (1)

Tim Peterson

Author, Maintainer, Copyright holder

Authors (2)

Tim Peterson

Author, Maintainer, Copyright holder

Thomas Westfall

Author

Copyright holders (1)

Tim Peterson

Author, Maintainer, Copyright holder

Package Timeline

1 release. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
0.2.0.0Latest
2026-03-10 · current release
R
R 4.5.0 released · 2025-04-11

Package metadata

First published: 2025-09-22
Total releases: 1 / 1 yrs
License: GPL-3 OSI
Minimum R: ≥ 3.5.0
Bundled data: 328 KB / 12 files
Download size: 2.5 MB
Installed size: not tracked yet
With dependencies: not tracked yet

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("hydroState")

Format

Peterson, T., & Westfall, T. (2025). hydroState: Hidden Markov Modelling of Hydrological State Change (Version 0.2.0.0) [Computer software]. https://doi.org/10.32614/CRAN.package.hydroState

This is what citation() produces when a package has no citation file of its own. If it prints something else, use that.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for hydroState version 0.2.0.0 [Data set]. HJJB, LLC. Data release v2026-08-22. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-22, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →