docs: readme and news update

Author: atsyplenkov

.gitignore

@@ -15,3 +15,4 @@ docs
 *.o
 *.so
 src/tidyhydro.dll
+tidyhydro.md

DESCRIPTION

@@ -1,11 +1,11 @@
 Package: tidyhydro
 Type: Package
 Title: Tidy Metrics for Assessing Hydrological Models Performance
-Version: 0.1.1.9000
+Version: 0.1.2
 Authors@R:
     person(given = "Anatoly", family = "Tsyplenkov", email = "atsyplenkov@fastmail.com", role = c("cre", "aut", "cph"), comment = c(ORCID = "0000-0003-4144-8402"))
 Maintainer: Anatoly Tsyplenkov <atsyplenkov@fastmail.com>
-Description: Provides tidy tools for comparing simulated and observed hydrological time series. Includes compatibility with the 'yardstick' package for model performance evaluation using commonly used metrics such as the Nash–Sutcliffe Efficiency (NSE), Kling–Gupta Efficiency (KGE), percent bias (pBIAS) and etc.
+Description: Provides tidy tools to measure the characteristics of hydrological time series and to assess the performance of hydrological models. Includes compatibility with the 'yardstick' package for model performance evaluation using commonly used metrics such as the Nash–Sutcliffe Efficiency (NSE), Kling–Gupta Efficiency (KGE), percent bias (pBIAS) and etc. Additionally provides a set of measures to calculate the descriptive statistics of a single dataset in accordance with Helsel et al. (2020). Helsel DR, Hirsch RM, Ryberg KR, Archfield SA, Gilroy EJ. Statistical methods in water resources. Reston, VA: 2020. <https://doi.org/10.3133/tm4A3>.
 License: MIT + file LICENSE
 Depends: R (>= 4.1.0)
 Imports:

NEWS.md

@@ -1,7 +1,9 @@
-# tidyhydro (development version)
+# tidyhydro 0.1.2
 
 ## New features
--   Added RMSE
+-   Added RMSE (`rmse`) and log-transformed KGE (`kgelog`, `kgelog_low` and `kgelog_hi`)
+-   Introduced descriptive statistics class — `measure`
+-   Added `cv`, `gm` measures
 
 ## Miscellaneous
 

README.Rmd

@@ -35,9 +35,9 @@ requireNamespace("bench", quietly = TRUE)
 
 The `tidyhydro` package provides a set of commonly used metrics in hydrology (such as _NSE_, _KGE_, _pBIAS_) for use within a [`tidymodels`](https://www.tidymodels.org/) infrastructure. Originally inspired by the [`yardstick`](https://github.com/tidymodels/yardstick/tree/main) and [`hydroGOF`](https://github.com/hzambran/hydroGOF) packages, this library is mainly written in C++ and provides a very quick estimation of desired goodness-of-fit criteria.
 
-Additionally, you'll find here a C++ implementation of lesser-known yet powerful metrics and coefficients recommended in the United States Geological Survey (USGS) and the National Environmental Monitoring Standards (NEMS) guidelines. Examples include _PRESS_ (Prediction Error Sum of Squares), _SFE_ (Standard Factorial Error), _MSPE_ (Model Standard Percentage Error) and others. Based on the equations from _Helsel et al._ ([2020](https://pubs.usgs.gov/publication/tm4A3)), _Rasmunsen et al._ ([2008](https://pubs.usgs.gov/tm/tm3c4/)), _Hicks et al._ ([2020](https://www.nems.org.nz/documents/suspended-sediment)) and etc. (see documentation for details).
+Additionally, you'll find here a C++ implementation of lesser-known yet powerful metrics and descriptive statistics recommended in the United States Geological Survey (USGS) and the National Environmental Monitoring Standards (NEMS) guidelines. Examples include _PRESS_ (Prediction Error Sum of Squares), _SFE_ (Standard Factorial Error), _MSPE_ (Model Standard Percentage Error) and others. Based on the equations from _Helsel et al._ ([2020](https://pubs.usgs.gov/publication/tm4A3)), _Rasmunsen et al._ ([2008](https://pubs.usgs.gov/tm/tm3c4/)), _Hicks et al._ ([2020](https://www.nems.org.nz/documents/suspended-sediment)) and etc. (see documentation for details).
 
-## Example
+## Performance metrics
 The `tidyhydro` package follows the philosophy of [`yardstick`](https://github.com/tidymodels/yardstick/tree/main) and provides S3 class methods for vectors and data frames. For example, one can estimate `KGE`, `NSE` or `pBIAS` for a data frame like this:
 
 ```{r example}
@@ -61,6 +61,17 @@ We do understand that sometimes one needs a qualitative interpretation of the mo
 hydro_metrics(avacha, obs, sim, performance = TRUE)
 ```
 
+## Descriptive statistics
+In addition to `metric`, inherited from `yardstick`, the `tidyhydro` introduces the `measure` objects. It aims to calculate descriptive statistics of a single dataset, such as `cv()` — coefficient of variation (a measure of variability) or `gm()` — geometric mean (a measure of central tendency):
+
+```{r measureset}
+# Coefficient of Variation
+cv(avacha, obs)
+
+# Geometric mean
+gm_vec(avacha$obs)
+```
+
 ## Installation
 
 You can install the development version of `tidyhydro` from [GitHub](https://github.com/atsyplenkov/tidyhydro) with:

README.md

@@ -4,7 +4,9 @@
 # tidyhydro
 
 <!-- badges: start -->
+
 <p align="center">
+
 <a href="https://github.com/atsyplenkov/tidyhydro/releases">
 <img src="https://img.shields.io/github/v/release/atsyplenkov/tidyhydro?style=flat&labelColor=1C2C2E&color=198ce7&logo=GitHub&logoColor=white"></a>
 <!-- <a href="https://cran.r-project.org/package=tidyhydro">
@@ -14,6 +16,7 @@
 <a href="https://github.com/atsyplenkov/tidyhydro/actions/workflows/check-r-pkg.yaml">
 <img src="https://img.shields.io/github/actions/workflow/status/atsyplenkov/tidyhydro/check-r-pkg.yaml?style=flat&labelColor=1C2C2E&color=256bc0&logo=GitHub%20Actions&logoColor=white"></a>
 </p>
+
 <!-- badges: end -->
 
 The `tidyhydro` package provides a set of commonly used metrics in
@@ -26,17 +29,18 @@ library is mainly written in C++ and provides a very quick estimation of
 desired goodness-of-fit criteria.
 
 Additionally, you’ll find here a C++ implementation of lesser-known yet
-powerful metrics and coefficients recommended in the United States
-Geological Survey (USGS) and the National Environmental Monitoring
-Standards (NEMS) guidelines. Examples include *PRESS* (Prediction Error
-Sum of Squares), *SFE* (Standard Factorial Error), *MSPE* (Model
-Standard Percentage Error) and others. Based on the equations from
-*Helsel et al.* ([2020](https://pubs.usgs.gov/publication/tm4A3)),
-*Rasmunsen et al.* ([2008](https://pubs.usgs.gov/tm/tm3c4/)), *Hicks et
-al.* ([2020](https://www.nems.org.nz/documents/suspended-sediment)) and
-etc. (see documentation for details).
-
-## Example
+powerful metrics and descriptive statistics recommended in the United
+States Geological Survey (USGS) and the National Environmental
+Monitoring Standards (NEMS) guidelines. Examples include *PRESS*
+(Prediction Error Sum of Squares), *SFE* (Standard Factorial Error),
+*MSPE* (Model Standard Percentage Error) and others. Based on the
+equations from *Helsel et al.*
+([2020](https://pubs.usgs.gov/publication/tm4A3)), *Rasmunsen et al.*
+([2008](https://pubs.usgs.gov/tm/tm3c4/)), *Hicks et al.*
+([2020](https://www.nems.org.nz/documents/suspended-sediment)) and etc.
+(see documentation for details).
+
+## Performance metrics
 
 The `tidyhydro` package follows the philosophy of
 [`yardstick`](https://github.com/tidymodels/yardstick/tree/main) and
@@ -88,6 +92,27 @@ hydro_metrics(avacha, obs, sim, performance = TRUE)
 #> 2 pbias   standard   Excellent
 ```
 
+## Descriptive statistics
+
+In addition to `metric`, inherited from `yardstick`, the `tidyhydro`
+introduces the `measure` objects. It aims to calculate descriptive
+statistics of a single dataset, such as `cv()` — coefficient of
+variation (a measure of variability) or `gm()` — geometric mean (a
+measure of central tendency):
+
+``` r
+# Coefficient of Variation
+cv(avacha, obs)
+#> # A tibble: 1 × 3
+#>   .metric .estimator .estimate
+#>   <chr>   <chr>          <dbl>
+#> 1 cv      standard       0.533
+
+# Geometric mean
+gm_vec(avacha$obs)
+#> [1] 128.9476
+```
+
 ## Installation
 
 You can install the development version of `tidyhydro` from
@@ -128,9 +153,9 @@ bench::mark(
 #> # A tibble: 3 × 6
 #>   expression   min median `itr/sec` mem_alloc `gc/sec`
 #>   <bch:expr> <dbl>  <dbl>     <dbl>     <dbl>    <dbl>
-#> 1 tidyhydro   1       1       28.7        NaN      NaN
-#> 2 hydroGOF   14.5    18.6      1          Inf      Inf
-#> 3 baseR       8.35   10.0      2.42       Inf      Inf
+#> 1 tidyhydro   1      1        13.3        NaN      NaN
+#> 2 hydroGOF    9.69   8.63      1          Inf      Inf
+#> 3 baseR       5.80   5.54      2.27       Inf      Inf
 ```
 
 ## Code of Conduct
@@ -142,8 +167,8 @@ By contributing to this project, you agree to abide by its terms.
 
 ## See also
 
--   [`hydroGOF`](https://github.com/hzambran/hydroGOF) - Goodness-of-fit
-    functions for comparison of simulated and observed hydrological time
-    series.
--   [`yardstick`](https://github.com/tidymodels/yardstick/tree/main) -
-    tidy methods for models performance assessment.
+- [`hydroGOF`](https://github.com/hzambran/hydroGOF) - Goodness-of-fit
+  functions for comparison of simulated and observed hydrological time
+  series.
+- [`yardstick`](https://github.com/tidymodels/yardstick/tree/main) -
+  tidy methods for models performance assessment.

codemeta.json

@@ -8,13 +8,13 @@
   "codeRepository": "https://github.com/atsyplenkov/tidyhydro",
   "issueTracker": "https://github.com/atsyplenkov/tidyhydro/issues",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.1.1.9000",
+  "version": "0.1.2",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 4.5.1 Patched (2025-06-14 r88315)",
+  "runtimePlatform": "R version 4.5.1 Patched (2025-06-20 r88332 ucrt)",
   "author": [
     {
       "@type": "Person",
@@ -128,9 +128,22 @@
       },
       "sameAs": "https://CRAN.R-project.org/package=yardstick"
     },
+    "5": {
+      "@type": "SoftwareApplication",
+      "identifier": "checkmate",
+      "name": "checkmate",
+      "version": ">= 2.3.1",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=checkmate"
+    },
     "SystemRequirements": null
   },
-  "fileSize": "7277.498KB",
+  "fileSize": "7300.242KB",
   "releaseNotes": "https://github.com/atsyplenkov/tidyhydro/blob/master/NEWS.md",
   "readme": "https://github.com/atsyplenkov/tidyhydro/blob/master/README.md",
   "keywords": ["r", "r-package", "rstats"]