R Observatory: Metrics for hydroGOF version 0.7-0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

hydroGOF

0.7-0Package record

Goodness-of-Fit Functions for Comparison of Simulated and Observed Hydrological Time Series

2packages dependsuggested by 3

34.4Kdownloads / year

43.0%test coverage

13/13flavors OK

Overview

About

Maintained by Mauricio Zambrano-BigiariniCRAN page ↗GitHub ↗Website ↗Issues ↗

S3 functions implementing both statistical and graphical goodness-of-fit measures between observed and simulated values, mainly oriented to be used during the calibration, validation, and application of hydrological models. Missing values in observed and/or simulated values can be removed before computations. Comments / questions / collaboration of any kind are very welcomed.

Changes in 0.7-0

New functions

o 'PMR' : to compute the Proxy for Model Robustness to quantify the temporal stability of model bias, proposed by Royer-Gaspard et al. (2021).

o 'JDKGE': to compute the Joint Divergence Kling-Gupta Efficiency, which extends the traditional Kling-Gupta efficiency by incorporating a fourth diagnostic component that evaluates the similarity between the probability distributions of simulated and observed values, proposed by Ficchi et al. (2026).

o 'LME' : to compute the Liu-Mean Efficiency, which evaluates how large the error is compared to the average level of the observations, making it particularly useful in hydrological applications where the mean value is a meaningful scale for evaluating prediction accuracy.

o 'LCE' : to compute the Lee and Choi Efficiency, which jointly assess the correlation, variability, and bias component of the error, while explicitly penalizing imbalances between correlation and variability through two complementary terms (r*Alpha and r/Alpha).

Bug fixes

o 'APFB' : -) Its value is now correctly computed, previously it was not Thanks to Rodrigo Mariano and Héctor Garcés.

-) New argument 'out.PerYear=FALSE' to define the whether the output should include the annual peak flow bias computed for each individual year or not.

o 'sKGE' : The content of 'Details' section in the documentation of this function was fixed, because it previously corresponded to the 'KGElf' function. Equations to summarise 'sKGE' were also added to the documentation. No change was made to the R code, only to the documentation.

o 'KGEkm': The second knowable moment K2 (dispersion-related quantity) is now correctly computed using ascending sorted values of 'sim' and 'obs' (previously the knowable moment K2 was computed using unsorted values of 'sim' and 'obs'). The other two components of the 'KGEkm' were previously correctly computed and now continue to do so.

Enhancements

o 'plot2' : -) now it shows and adaptive time axis for sub-daily zoo objects.

Show all changes in 0.7-0Hide the rest of the changes in 0.7-0

-) to reduce the large amount of metrics shown by default in the legend, the 18 metrics previously shown by default ( c("ME", "MAE", "RMSE", "NRMSE", "PBIAS", "RSR", "rSD", "NSE", "mNSE", "rNSE", "d", "md", "rd", "r", "R2", "bR2", "KGE", "VE") ) were reduced to only 14 ( c( "ME", "MAE", "RMSE", "NRMSE", "PBIAS", "NSE", "d", "dr", "r", "R2", "KGE", "LCE", "JDKGE", "VE") )

o 'ggof' : -) now it shows and adaptive time axis for sub-daily zoo objects.

-) now it returns the graphical device to its status before calling this function.

-) to reduce the large amount of metrics shown by default in the legend, the 18 metrics previously shown by default ( c("ME", "MAE", "RMSE", "NRMSE", "PBIAS", "RSR", "rSD", "NSE", "mNSE", "rNSE", "d", "md", "rd", "r", "R2", "bR2", "KGE", "VE") ) were reduced to only 14 ( c( "ME", "MAE", "RMSE", "NRMSE", "PBIAS", "NSE", "d", "dr", "r", "R2", "KGE", "LCE", "JDKGE", "VE") )

o 'gof' : -) now it does not compute sKGE, APFB and HFB when sim and obs are annual zoo objects.

-) it now computes the values of the new PMR, JDKGE, LME, and LCE metrics.

o 'NRMSE' : in addition to the standard deviation and the range of observations, now it is possible to normlise the RMSE by the mean and IQRT of observations.

o 'pfactor': improved 'Details' section in the documentation, including new equations.

o 'rfactor': improved 'Details' section in the documentation, including new equations.

o 'HFB' : -) improved 'Details' section in the documentation, including new equations.

-) it mathematical formualtion was completly changed, in order to make it more compatible with APFB and PBIAS, with an optimum value in 0 and not in 1, as it was previpusly implmented in version 0.6-0.1.

Package files

o hydroGOF now has a graphical logo.

o hydroGOF now has a webpage (https://hzambran.github.io/hydroGOF/), created by pkgdown.

o CITATION file : The DOI was changed form the one given by Zotero to the new DOI given by CRAN (10.32614/CRAN.package.hydroGOF) since June 2024.

o NAMESPACE file: now imports the 'shiftyears' function of the hydroTSM R package.

From NEWS.md in the release

Install

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

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

Development version from hzambran/hydroGOF. 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-hydrogof

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

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

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: 5.1 min · r-oldrel-windows-x86_64

Status changes

OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK12 OK2026-04-25
ERROR13 OK, 1 ERROR2026-03-30
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.7-0

README· In the repository, left out of the releaseVignettesYes · 1 · dynamicNEWSYes · 67% structured · mentions 0.7-0Citation fileYes · computed when R runs itWebsiteYes · pkgdown

Help pages: 48 (1 internal)includes a package overview page
Examples that run: 98%45 run in a plain check · 1 never run
Exported functions with examples: 100%
Documented parameters: not tracked
Return-value docs: not tracked
Help pages citing references: 98%

Vignettes (1)

Goodness-of-fit measures to compare observed and simulated time series with hydroGOF

How these are measured

Downloads

34.4K

CRAN downloads in the past year

Rank #2,429 · ~94/day · ~2.9K/mo

Releases R versions

Daily download trend is not available in this view yet.

2.4K30 days

6.7K90 days

34.4K1 year

Compare downloads with other packages →

Also on168 r2u2 autocran2.3K conda_forge182 c2d4u

How downloads are counted

Repository

hzambran/hydrogof ↗Account: hzambran

45Stars

14Forks

1Open issues

2Open PRs

8Releases

696Commits

2Commit identities

696 commits · Last activity 2026-09-22 · 0% stars, 30d · Default branch at 0.7-4, ahead of CRAN 0.7-0 (checked 2026-10-22)

Responsiveness

How these are sampled

PRs merged (all time): 50%
Median days to close, 50 most recently updated closed issues: 216
Median days to close, 50 most recently updated closed PRs: 522

Stars over time

2025-10-18 · 422026-08-06 · 45

How these are measured

PracticesBeta

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

Checks run against github.com/hzambran/hydrogof on 2026-10-22.

Continuous integration (3)

GitHub ActionsR CMD check workflowTravis CI (config file)

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (3)

pkgdown

GitHub Pages site last deployed 2026-09-22 · The repository has a site deploy workflow

pkgdown site last built 2026-09-22

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

Dependencies

Declared dependencies

6 external dependencies (excludes base and recommended)

Installing hydroGOF adds 8 packages (6 with compiled code, 5.8 MB of source tarballs). Heaviest: hydroTSM 3.5 MB, zoo 675 KB, xts 470 KB.

Depends (2)

R >= 2.10.0zoo

Imports (4)

hydroTSM xtsmethodsstats

LinkingTo (0)

none

Suggests (3)

knitr rmarkdown testthat

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

2direct

0indirect

Imports 2

Suggested by 3

Depends, Imports or LinkingTo, most downloaded first

aws.wrfsmn RFplus

Suggests, most downloaded first

wxgenR hydroMOPSO DWBmodelUN

How these are counted

Code & Tests

Datasets

People & History

People (1)

Mauricio Zambrano-Bigiarini

Author, Maintainer, Copyright holder · added in 0.3-10

Maintainer since 0.2-0 (2010)

Listed in earlier versions (1)

Mauricio Zambrano Bigiarini

no longer listed · 0.2-0 to 0.2-2

Releases (18)

Pick two releases to compare their code metrics.

0.7-0Latest
record
2026-05-01 · current release · diff ↗
R
R 4.6.0 released · 2026-04-24
R
R 4.5.0 released · 2025-04-11
0.6-0.1
record
2024-11-04 · diff ↗
0.6-0
record
2024-05-09 · diff ↗
R
R 4.4.0 released · 2024-04-24
unarchivedReturned to CRAN
2024-01-21
0.5-4
record
2024-01-21 · diff ↗
archivedRemoved from CRAN
2023-10-16
requires archived package 'hydroTSM'
R
R 4.3.0 released · 2023-04-21
R
R 4.2.0 released · 2022-04-22
R
R 4.1.0 released · 2021-05-18
R
R 4.0.0 released · 2020-04-24
0.4-0
record
2020-03-12 · diff ↗
R
R 3.6.0 released · 2019-04-26
R
R 3.5.0 released · 2018-04-23

Show 23 earlier eventsHide 23 earlier events

0.3-10
record
2017-08-08 · diff ↗
R
R 3.4.0 released · 2017-04-21
R
R 3.3.0 released · 2016-05-03
R
R 3.2.0 released · 2015-04-16
R
R 3.1.0 released · 2014-04-10
0.3-8
record
2014-02-04 · diff ↗
0.3-7
record
2013-06-03 · diff ↗
R
R 3.0.0 released · 2013-04-03
0.3-6
record
2013-03-25 · diff ↗
0.3-5
record
2012-10-19 · diff ↗
0.3-4
record
2012-07-03 · diff ↗
0.3-3
record
2012-05-02 · diff ↗
R
R 2.15.0 released · 2012-03-30
R
R 2.14.0 released · 2011-10-31
0.3-2
record
2011-10-08 · diff ↗
0.3-1
record
2011-09-15 · diff ↗
0.3-0
record
2011-09-01 · diff ↗ ·
added 1 export
pattern:^[^\\.]
0.2-2
record
2011-04-14 · diff ↗
R
R 2.13.0 released · 2011-04-13
0.2-1
record
2010-11-30 · diff ↗
R
R 2.12.0 released · 2010-10-15
0.2-0
record
2010-10-11
R
R 2.11.0 released · 2010-04-22

Package metadata

First published: 2010-10-11
Total releases: 18 / 16 yrs
License: GPL (>= 2) OSI
Minimum R: ≥ 2.10.0
Bundled data: 6.8 KB / 1 file
Download size: 3.2 MB

Appears in task views

Hydrological Data and Modeling

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("hydroGOF")

The package provides a citation file that builds its entry when R runs it. Run citation() to see it.

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 hydroGOF version 0.7-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 →