Type: Package
Package: HGDMr
Title: Hysteretic and Gatekeeping Depressions Model
Version: 1.0.1
Date: 2025-12-08
Authors@R: c(person("Kevin", "Shook", 
              email = "kshook@kshook.ca", 
              role = c("cre", "aut"))
             )                
Author: Kevin Shook [cre, aut]
Maintainer: Kevin Shook <kshook@kshook.ca>
Description: 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>).
License: GPL-3
URL: https://github.com/CentreForHydrology/HGDMr
Depends: R (>= 4.0.0)
Imports: stringr, stats
Suggests: knitr, testthat, rmarkdown, readr, ggplot2
VignetteBuilder: knitr
LazyData: true
Encoding: UTF-8
RoxygenNote: 7.3.2
NeedsCompilation: no
Packaged: 2025-12-08 19:03:10 UTC; kevin
Repository: CRAN
Date/Publication: 2025-12-08 21:30:07 UTC
Built: R 4.6.0; ; 2026-04-26 03:52:32 UTC; unix
