docs: spelling and grammar

Author: atsyplenkov

.github/CONTRIBUTING.md

@@ -61,4 +61,6 @@ Please note that the tidyhydro project is released with a [Contributor Code of C
 
 -[ ] MSPE - model standard percentage error log and nonlog [@rasmussenGuidelinesProceduresComputing2009, p. 13]
 
--[ ] RMSE
+-[x] RMSE
+
+-[ ] Coefficient of Variation

NEWS.md

@@ -5,7 +5,7 @@
 
 ## Miscellaneous
 
--   Added structure. Functions are now groupped into two categories: regression and GOF
+-   Added structure. Functions are now grouped into two categories: regression and GOF
 
 # tidyhydro 0.1.1
 
@@ -16,8 +16,8 @@
 
 ## Bug fixes
 
--   Improved documenation by switching from `\url` to `\doi`
--   Removed unicode characters α, β
+-   Improved documentation by switching from `\url` to `\doi`
+-   Removed unicode characters
 
 ## Miscellaneous
 

R/data.R

@@ -1,9 +1,9 @@
-#' Mean Daily Water Discharge At Avacha River (Elizovo City)
+#' Mean daily water discharge at the Avacha River (Elizovo City)
 #' @keywords data
 #' 
 #' @details These data contain the measured (`obs`) mean daily water discharge
-#' values (in \eqn{m^3/s}) at the Avacha River -- Elizovo City state gauging
-#' station for the 2022 calendar year. They are accompanied by the GloFAS v4.0
+#' values (in \eqn{m^3/s}) at the Avacha River streamgage near Elizovo City, 
+#' Russia, 2022 calendar year. They are accompanied by the GloFAS v4.0
 #' reanalysis water discharge values for the last 24 hours (`sim`), derived
 #' from
 #' \url{https://ewds.climate.copernicus.eu/datasets/cems-glofas-historical}.
@@ -17,8 +17,9 @@
 #' @return \item{avacha}{a data frame}
 #'
 #' @source
-#' * \url{https://gmvo.skniivh.ru/}
-#' * \url{https://ewds.climate.copernicus.eu/datasets/cems-glofas-historical}
+#' * observed water discharge \url{https://gmvo.skniivh.ru/}
+#' * simulated water discharge 
+#'   \url{https://ewds.climate.copernicus.eu/datasets/cems-glofas-historical}
 #'
 #' @keywords datasets
 #' @examples

README.Rmd

@@ -35,7 +35,7 @@ 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 used in reports from 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), and _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 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
 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:

README.md

@@ -26,15 +26,15 @@ 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 used in reports from 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), and *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).
+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
 
@@ -128,9 +128,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       22.7        NaN      NaN
-#> 2 hydroGOF   15.2    19.1      1          Inf      Inf
-#> 3 baseR       8.66   10.6      2.44       Inf      Inf
+#> 1 tidyhydro   1       1       30.2        NaN      NaN
+#> 2 hydroGOF   14.8    20.0      1          Inf      Inf
+#> 3 baseR       8.44   10.3      2.55       Inf      Inf
 ```
 
 ## Code of Conduct