HGDMr

1.0.1

Hysteretic and Gatekeeping Depressions Model

0packages depend

2Kdownloads / year

–test coverage

12/13checks pass

Overview

About

Maintained by Kevin ShookFirst published 2025-02-212 releasesCRAN page ↗GitHub ↗

Implementation of the Hysteretic and Gatekeeping Depressions Model (HGDM) which calculates variable connected/contributing areas and resulting discharge volumes in prairie basins dominated by depressions ("slough" or "potholes"). The small depressions are combined into a single "meta" depression which explicitly models the hysteresis between the storage of water and the connected/contributing areas of the depressions. The largest (greater than 5% of the total depressional area) depression (if it exists) is represented separately to model its gatekeeping, i.e. the blocking of upstream flows until it is filled. The methodolgy is described in detail in Shook and Pomeroy (2025, doi:10.1016/j.jhydrol.2025.132821).

Install

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

install.packages("HGDMr", 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("CentreForHydrology/HGDMr")

Development version from CentreForHydrology/HGDMr. 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-hgdmr

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

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

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

Health

CRAN checks

1NOTE12OK

Failing flavors

NOTE r-devel-linux-x86_64-debian-gcc

Slowest check: 1.5 min · r-oldrel-macos-x86_64

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

Dependencies · direct

Check history

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 · 224 wordsVignettesYes · dynamicpkgdown siteNoNEWSNoCode of conductNoContributing guideNo

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

Downloads

CRAN downloads in the past year

Rank #22,026 · ~6/day · ~168/mo

Releases R versions

Daily download trend is not available in this view yet.

11930 days

49490 days

2K1 year

Compare downloads with other packages →

Also on129 r2u1 autocran

Repository

GitHub ↗ centreforhydrology/hgdmr

0Stars

0Forks

0Open issues

0Open PRs

0Releases

Last activity 2025-02-21

Repository practices

Upstream repositoryBeta

1 development-tooling and community-health practice detected across 1 family in the upstream repository

Checks run against github.com/centreforhydrology/hgdmr on 2026-08-02.

Lint, format, editor (1)

RStudio project

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

Dependencies

Declared dependencies

6 external dependencies (excludes base and recommended)

Depends (1)

R >= 4.0.0

Imports (2)

stringrstats

LinkingTo (0)

none

Suggests (5)

knitr testthat rmarkdown readr ggplot2

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Datasets

People & History

People (1)

Maintainer (1)

Kevin Shook

Maintainer, Author

Authors (1)

Kevin Shook

Maintainer, Author

Package Timeline

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

R
R 4.6.0 released · 2026-04-24
1.0.1Latest
2025-12-08 · current release · diff ↗
R
R 4.5.0 released · 2025-04-11
1.0.0
2025-02-21
R
R 4.4.0 released · 2024-04-24

Package metadata

First published: 2025-02-21
Total releases: 2 / 1 yrs
License: GPL-3 OSI
Minimum R: ≥ 4.0.0
Bundled data: 121 KB / 1 file
Download size: 3.4 MB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →