docs: update documentation for PRESS

Author: atsyplenkov

.Rbuildignore

@@ -11,6 +11,7 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^vignettes/\.quarto$
 ^vignettes/articles/\.quarto$
 ^vignettes/articles/*_files$
 ^vignettes/articles$

R/press.R

@@ -29,6 +29,11 @@
 #'   \item \eqn{obs} defines model observations at time step \eqn{i}
 #' }
 #'
+#' @note
+#' The $PRESS$ statistic is not appropriate for comparison of models having
+#' different transformations of response variable, e.g. linear regression and
+#' log-transformed linear regression (*Helsel et al., 2020*).
+#'
 #' @family numeric metrics
 #' @family accuracy metrics
 #' @templateVar fn press

README.Rmd

@@ -24,8 +24,8 @@ requireNamespace("bench", quietly = TRUE)
 <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">
-        <img src="https://img.shields.io/cran/v/tidyhydro?style=flat&labelColor=1C2C2E&color=198ce7&logo=R&logoColor=white"></a>
+    <!-- <a href="https://cran.r-project.org/package=tidyhydro">
+        <img src="https://img.shields.io/cran/v/tidyhydro?style=flat&labelColor=1C2C2E&color=198ce7&logo=R&logoColor=white"></a> -->
     <a href="https://app.codecov.io/gh/atsyplenkov/tidyhydro">
         <img src="https://img.shields.io/codecov/c/gh/atsyplenkov/tidyhydro?style=flat&labelColor=1C2C2E&color=256bc0&logo=Codecov&logoColor=white"></a>
     <a href="https://github.com/atsyplenkov/tidyhydro/actions/workflows/check-r-pkg.yaml">

README.md

@@ -4,16 +4,19 @@
 # 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">
-<img src="https://img.shields.io/cran/v/tidyhydro?style=flat&labelColor=1C2C2E&color=198ce7&logo=R&logoColor=white"></a>
+<!-- <a href="https://cran.r-project.org/package=tidyhydro">
+        <img src="https://img.shields.io/cran/v/tidyhydro?style=flat&labelColor=1C2C2E&color=198ce7&logo=R&logoColor=white"></a> -->
 <a href="https://app.codecov.io/gh/atsyplenkov/tidyhydro">
 <img src="https://img.shields.io/codecov/c/gh/atsyplenkov/tidyhydro?style=flat&labelColor=1C2C2E&color=256bc0&logo=Codecov&logoColor=white"></a>
 <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
@@ -140,15 +143,15 @@ 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       29.2        NaN      NaN
-#> 2 hydroGOF   15.8    21.2      1          Inf      Inf
-#> 3 baseR       8.54   10.6      2.32       Inf      Inf
+#> 1 tidyhydro    1      1       39.1        NaN      NaN
+#> 2 hydroGOF    30.8   33.7      1          Inf      Inf
+#> 3 baseR       20.5   21.6      1.92       Inf      Inf
 ```
 
 ## 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.