From 186f8a8f4bf77c96a8945d039dc1c9f816108d02 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.priv>
Date: Mon, 15 Oct 2018 10:55:35 +0200
Subject: [PATCH] v1.0.15.3 UPDATE: CreateInputsCrit doc (explanations,
details, and ref)
---
DESCRIPTION | 4 ++--
NEWS.rmd | 8 ++++++++
man/CreateInputsCrit.Rd | 8 ++++++--
3 files changed, 16 insertions(+), 4 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 733080b1..4fe57117 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,8 +1,8 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.0.15.2
-Date: 2018-10-10
+Version: 1.0.15.3
+Date: 2018-10-15
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
person("Charles", "Perrin", role = c("aut", "ths"), comment = c(ORCID = "0000-0001-8552-1881")),
diff --git a/NEWS.rmd b/NEWS.rmd
index 5a1d80db..06a7948a 100644
--- a/NEWS.rmd
+++ b/NEWS.rmd
@@ -13,6 +13,14 @@ output:
+### 1.0.15.3 Release Notes (2018-10-15)
+
+
+
+
+____________________________________________________________________________________
+
+
### 1.0.15.2 Release Notes (2018-10-10)
diff --git a/man/CreateInputsCrit.Rd b/man/CreateInputsCrit.Rd
index 3d34d87b..5653f3ed 100644
--- a/man/CreateInputsCrit.Rd
+++ b/man/CreateInputsCrit.Rd
@@ -29,7 +29,7 @@ CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions, Qobs, BoolCrit = NULL,
\item{Ind_zeroes}{(deprecated) [numeric] indices of the time steps where zeroes are observed}
-\item{epsilon}{(optional) [numeric] epsilon to add to all Qobs and Qsim if \emph{$Ind_zeroes} is not empty}
+\item{epsilon}{(optional) [numeric] small value to add to all Qobs and Qsim (useful when \code{"log"} or \code{"inv"} transformations are used) [same unit as Qobs]}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}}
}
@@ -55,7 +55,8 @@ Creation of the \emph{InputsCrit} object required to the \code{ErrorCrit*} funct
\details{
Users wanting to use \code{FUN_CRIT} functions that are not included in
the package must create their own InputsCrit object accordingly. \cr
-We do not advise computing KGE or KGE' with log-transformation as it might be wrongly influenced by discharge values close to 0 or 1 and it is dependent on the discharge unit. See Santos et al. (in review) for more details and alternative solutions (see the reference below).
+The epsilon value is useful when \code{"log"} or \code{"inv"} transformations are used (to avoid division by zero). The effect of this value and recommendation about the epsilon value to use (usually one hundredth of average Qobs) are discussed in Pushpalatha et al. (2012) for NSE and Santos et al. (2018) for KGE and KGE'. \cr
+We do not advise computing KGE or KGE' with log-transformation as it might be wrongly influenced by discharge values close to 0 or 1 and it is dependent on the discharge unit. See Santos et al. (2018) for more details and alternative solutions (see the reference below).
}
@@ -123,6 +124,9 @@ Laurent Coron, Olivier Delaigue, Guillaume Thirel
}
\references{
+Pushpalatha, R., Perrin, C., Le Moine, N. and Andréassian, V. (2012),
+ A review of efficiency criteria suitable for evaluating low-flow simulations,
+ Journal of Hydrology, 420-421: 171-182, doi:10.1016/j.jhydrol.2011.11.055. \cr
Santos, L., Thirel, G. and Perrin, C. (2018),
Technical note: Pitfalls in using log-transformed flows within the KGE criterion,
Hydrology and Earth System Sciences Discussions, 22, 4583-4591, doi:10.5194/hess-2018-298.
--
GitLab