R Observatory: Metrics for hydroState version 0.2.0.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

hydroState

0.2.0.0Package record

Hidden Markov Modelling of Hydrological State Change

0packages depend

2.3Kdownloads / year

–test coverage

13/13flavors OK

Overview

About

Maintained by Tim PetersonCRAN page ↗GitHub ↗Website ↗Issues ↗

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.

Changes in 0.2.0.0

Initial CRAN submission in the making! 🎉
Main Functions:
build()
build.all()
fit.hydroState()
setInitialYear()
plot.hydroState()
get.AIC()
Vignette:
Getting Started
Adjust default state model
Seasonal and monthly models

From NEWS.md in the release

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. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

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). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

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

Status changes

OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.2.0.0

READMEYes · 589 wordsVignettes· In the repository, left out of the releaseNEWSYes · 67% structured · mentions 0.2.0.0Citation fileYes · cites a publicationWebsiteYes · pkgdown

Help pages: 13 (1 internal)includes a package overview page
Examples that run: 91%10 run in a plain check · 1 only when donttest examples are enabled (R CMD check --as-cran)
Exported functions with examples: 100%
Documented parameters: 85%
Return-value docs: 100%
Help pages citing references: 0%

How these are measured

Downloads

2.3K

CRAN downloads in the past year

Rank #19,863 · ~6/day · ~191/mo

Releases R versions

Daily download trend is not available in this view yet.

22330 days

67090 days

2.3K1 year

Compare downloads with other packages →

Also on66 r2u3 autocran

How downloads are counted

Repository

peterson-tim-j/hydrostate ↗Account: peterson-tim-j

12Stars

9Forks

7Open issues

2Open PRs

1Releases

110Commits

4Commit identities

hydrologystreamflowhidden-markov-modelstatistics

110 commits · Last activity 2025-11-07 · 0% stars, 30d

Responsiveness

How these are sampled

PRs merged (all time): 67%
Median days to close, 50 most recently updated closed issues: 8
Median days to close, 50 most recently updated closed PRs: 0

Stars over time

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

How these are measured

PracticesBeta

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

Checks run against github.com/peterson-tim-j/hydrostate on 2026-10-21.

Continuous integration (1)

GitHub Actions

Docs source (3)

pkgdown

GitHub Pages site last deployed 2025-11-07 · The repository has a site deploy workflow

pkgdown site last built 2025-11-07

CRAN release process (2)

cran-comments.mdCRAN-SUBMISSION

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies

11 external dependencies (excludes base and recommended)

Installing hydroState adds 33 packages (21 with compiled code, 15 MB of source tarballs). Heaviest: padr 2.9 MB, Rcpp 1.8 MB, vctrs 1.0 MB.

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.

How these are counted

Code & Tests

Datasets

People & History

People (2)

Tim Peterson

Thomas Westfall

Author

Releases (1)

R
R 4.6.0 released · 2026-04-24
0.2.0.0Latest
record
2025-09-22 · 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

Cite

Cite this package

Run in R for the authors' entry:

citation("hydroState")

The package provides a citation file, so citation() returns the authors' own entry.

It points to 10.1126/science.abd5085.

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-10-24. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-24, 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 →