Merge pull request #23 from atsyplenkov/dev

update news

Author: atsyplenkov

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
 

vignettes/articles/available_metrics.qmd

@@ -10,6 +10,11 @@ knitr:
     message: false
 ---
 
+<!-- TODO: use `gt` for tables -->
+
+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` | <span style="font-size: 0.8em;">Nash, J. E., & Sutcliffe, J. V. (1970). *Journal of Hydrology*, 10(3), 282–290.</span> |
 | Mean Squared Error | $MSE$ | `mse` | <span style="font-size: 0.8em;">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.</span> |
 | Percent BIAS | $pBIAS$ | `pbias` | <span style="font-size: 0.8em;">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 </span> |
+
+
+# Regression
+
+| Name | Abbr. | Function calls | Reference |
+|----------------|--------|--------|-------------|
 | PRediction Error Sum of Squares | $PRESS$ | `press` | <span style="font-size: 0.8em;"> 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)</span> |
 | Standard Factorial Error | $SFE$ | `sfe` | <span style="font-size: 0.8em;"> Herschy, R.W. 1978: Accuracy. Chapter 10 In: Herschy, R.W. (ed.) Hydrometry - principles and practices. John Wiley and Sons, Chichester, 511 p.</span> |
-
-: Metrics currently implemented in `tidyhydro` v`r packageVersion("tidyhydro")`