Skip to content

Commit 262dc12

Browse files
committed
README update
1 parent 00ae8c0 commit 262dc12

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ requireNamespace("bench", quietly = TRUE)
3535

3636
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.
3737

38-
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).
38+
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 New Zealand 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).
3939

4040
## Performance metrics
4141
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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ desired goodness-of-fit criteria.
3030

3131
Additionally, you’ll find here a C++ implementation of lesser-known yet
3232
powerful metrics and descriptive statistics recommended in the United
33-
States Geological Survey (USGS) and the National Environmental
34-
Monitoring Standards (NEMS) guidelines. Examples include *PRESS*
35-
(Prediction Error Sum of Squares), *SFE* (Standard Factorial Error),
36-
*MSPE* (Model Standard Percentage Error) and others. Based on the
37-
equations from *Helsel et al.*
33+
States Geological Survey (USGS) and the New Zealand National
34+
Environmental Monitoring Standards (NEMS) guidelines. Examples include
35+
*PRESS* (Prediction Error Sum of Squares), *SFE* (Standard Factorial
36+
Error), *MSPE* (Model Standard Percentage Error) and others. Based on
37+
the equations from *Helsel et al.*
3838
([2020](https://pubs.usgs.gov/publication/tm4A3)), *Rasmunsen et al.*
3939
([2008](https://pubs.usgs.gov/tm/tm3c4/)), *Hicks et al.*
4040
([2020](https://www.nems.org.nz/documents/suspended-sediment)) and etc.
@@ -153,9 +153,9 @@ bench::mark(
153153
#> # A tibble: 3 × 6
154154
#> expression min median `itr/sec` mem_alloc `gc/sec`
155155
#> <bch:expr> <dbl> <dbl> <dbl> <dbl> <dbl>
156-
#> 1 tidyhydro 1 1 13.3 NaN NaN
157-
#> 2 hydroGOF 9.69 8.63 1 Inf Inf
158-
#> 3 baseR 5.80 5.54 2.27 Inf Inf
156+
#> 1 tidyhydro 1 1 16.5 NaN NaN
157+
#> 2 hydroGOF 9.74 11.5 1 Inf Inf
158+
#> 3 baseR 6.40 7.92 2.09 Inf Inf
159159
```
160160

161161
## Code of Conduct

0 commit comments

Comments
 (0)