ErrorCrit_KGE2.Rd 3.05 KB
 Delaigue Olivier committed Oct 28, 2015 1 \encoding{UTF-8}  unknown committed Apr 05, 2017 2   Delaigue Olivier committed Oct 28, 2015 3 4 \name{ErrorCrit_KGE2} \alias{ErrorCrit_KGE2}  unknown committed Apr 05, 2017 5   Delaigue Olivier committed Oct 28, 2015 6 \title{Error criterion based on the KGE' formula}  unknown committed Apr 05, 2017 7   Delaigue Olivier committed Oct 28, 2015 8 \usage{  unknown committed Dec 07, 2016 9 ErrorCrit_KGE2(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)  Delaigue Olivier committed Oct 28, 2015 10 }  unknown committed Apr 05, 2017 11   Delaigue Olivier committed Oct 28, 2015 12 13 14 15 16 \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details}  unknown committed Dec 07, 2016 17 18 19 \item{warnings}{(optional) [boolean] boolean indicating if the warning messages are shown, default = \code{TRUE}} \item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}}  Delaigue Olivier committed Oct 28, 2015 20 21 22 23 24 25 26 } \value{ [list] list containing the function outputs organised as follows: \tabular{ll}{ \emph{$CritValue } \tab [numeric] value of the criterion \cr \emph{$CritName } \tab [character] name of the criterion \cr \emph{$SubCritValues } \tab [numeric] values of the sub-criteria \cr  Delaigue Olivier committed Apr 21, 2016 27  \emph{$SubCritNames } \tab [character] names of the components of the criterion \cr  Delaigue Olivier committed Oct 28, 2015 28 29  \emph{$CritBestValue } \tab [numeric] theoretical best criterion value \cr \emph{$Multiplier } \tab [numeric] integer indicating whether the criterion is indeed an error (+1) or an efficiency (-1) \cr  Delaigue Olivier committed Apr 14, 2016 30  \emph{$Ind_notcomputed} \tab [numeric] indices of the time steps where InputsCrit$BoolCrit=FALSE or no data is available \cr  Delaigue Olivier committed Oct 28, 2015 31 32  } }  unknown committed Apr 05, 2017 33   Delaigue Olivier committed Oct 28, 2015 34 35 36 \description{ Function which computes an error criterion based on the KGE' formula proposed by Kling et al. (2012). }  unknown committed Apr 05, 2017 37   Delaigue Olivier committed Oct 28, 2015 38 \details{  Delaigue Olivier committed Dec 09, 2015 39 In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows  unknown committed Apr 05, 2017 40 41 42 43 the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised (Multiplier=-1 for KGE2).\cr\cr The KGE' formula is \deqn{KGE' = 1 - \sqrt{(r - 1)^2 + (\gamma - 1)^2 + (\beta - 1)^2}}{KGE' = 1 - sqrt((r - 1)² + (\gamma - 1)² + (\beta - 1)²)} with the following sub-criteria:  44 \deqn{r = \mathrm{the\: linear\ correlation\: coefficient\: between\:} sim\: \mathrm{and\:} obs}{r = is the linear correlation coefficient between Q[sim] and Q[obs]}  45 46 \deqn{\gamma = \frac{CV_{sim}}{CV_{obs}}}{\gamma = CV[sim] / CV[obs]} \deqn{\beta = \frac{\mu_{sim}}{\mu_{obs}}}{\beta = \mu[sim] / \mu[obs]}  Delaigue Olivier committed Oct 28, 2015 47 }  unknown committed Apr 05, 2017 48   Delaigue Olivier committed Oct 28, 2015 49 50 51 \examples{ ## see example of the ErrorCrit function }  unknown committed Apr 05, 2017 52   Delaigue Olivier committed Oct 28, 2015 53 \author{  unknown committed Apr 05, 2017 54 Laurent Coron  Delaigue Olivier committed Oct 28, 2015 55 }  unknown committed Apr 05, 2017 56   Delaigue Olivier committed Oct 28, 2015 57 \references{  Delaigue Olivier committed Dec 09, 2015 58 Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),  Delaigue Olivier committed Oct 28, 2015 59 60  Decomposition of the mean squared error and NSE performance criteria: Implications for improving hydrological modelling, Journal of Hydrology, 377(1-2), 80-91, doi:10.1016/j.jhydrol.2009.08.003. \cr  Delaigue Olivier committed Dec 09, 2015 61  Kling, H., Fuchs, M. and Paulin, M. (2012),  Delaigue Olivier committed Oct 28, 2015 62 63 64  Runoff conditions in the upper Danube basin under an ensemble of climate change scenarios, Journal of Hydrology, 424-425, 264-277, doi:10.1016/j.jhydrol.2012.01.011. }  unknown committed Apr 05, 2017 65   Delaigue Olivier committed Oct 28, 2015 66 \seealso{  unknown committed Apr 05, 2017 67 \code{\link{ErrorCrit}}, \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}}, \code{\link{ErrorCrit_KGE}}  Delaigue Olivier committed Oct 28, 2015 68 69 }