diff --git a/NEWS.md b/NEWS.md index ca65707..6c81bf3 100644 --- a/NEWS.md +++ b/NEWS.md @@ -7,7 +7,8 @@ ## Miscellaneous -- Added structure. Functions are now grouped into two categories: regression and GOF +- Added structure. Functions are now grouped into three categories: GOF, regression and descriptive statistics +- Improved parameter testing via `quickcheck` # tidyhydro 0.1.1 diff --git a/vignettes/articles/available_metrics.qmd b/vignettes/articles/available_metrics.qmd index cd373de..6b2199d 100644 --- a/vignettes/articles/available_metrics.qmd +++ b/vignettes/articles/available_metrics.qmd @@ -10,6 +10,11 @@ knitr: message: false --- + + +Metrics and descriptive statistics currently implemented in `tidyhydro` v`r packageVersion("tidyhydro")` + + # Goodness-of-fit criteria | Name | Abbr. | Function calls | Reference | @@ -20,7 +25,11 @@ knitr: | Nash-Sutcliffe Efficiency | $NSE$ | `nse` | Nash, J. E., & Sutcliffe, J. V. (1970). *Journal of Hydrology*, 10(3), 282–290. | | Mean Squared Error | $MSE$ | `mse` | Clark, M. P., Vogel, R. M., Lamontagne, J. R., Mizukami, N., Knoben, W. J. M., Tang, G., Gharari, S., Freer, J. E., Whitfield, P. H., Shook, K. R., & Papalexiou, S. M. (2021). The Abuse of Popular Performance Metrics in Hydrologic Modeling. Water Resources Research, 57(9), e2020WR029001. | | Percent BIAS | $pBIAS$ | `pbias` | Gupta, H. V., S. Sorooshian, and P. O. Yapo. (1999). Status of automatic calibration for hydrologic models: Comparison with multilevel expert calibration. J. Hydrologic Eng. 4(2): 135-143 | + + +# Regression + +| Name | Abbr. | Function calls | Reference | +|----------------|--------|--------|-------------| | PRediction Error Sum of Squares | $PRESS$ | `press` | Rasmussen, P. P., Gray, J. R., Glysson, G. D. & Ziegler, A. C. Guidelines and procedures for computing time-series suspended-sediment concentrations and loads from in-stream turbidity-sensor and streamflow data. in U.S. Geological Survey Techniques and Methods book 3, chap. C4 53 (2009) | | Standard Factorial Error | $SFE$ | `sfe` | Herschy, R.W. 1978: Accuracy. Chapter 10 In: Herschy, R.W. (ed.) Hydrometry - principles and practices. John Wiley and Sons, Chichester, 511 p. | - -: Metrics currently implemented in `tidyhydro` v`r packageVersion("tidyhydro")`