ErrorCrit_KGE2.Rd 2.5 KB
 Delaigue Olivier committed Dec 09, 2015 1 % Generated by roxygen2: do not edit by hand  Delaigue Olivier committed Oct 28, 2015 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 % Please edit documentation in R/ErrorCrit_KGE2.R \encoding{UTF-8} \name{ErrorCrit_KGE2} \alias{ErrorCrit_KGE2} \title{Error criterion based on the KGE' formula} \usage{ ErrorCrit_KGE2(InputsCrit, OutputsModel, quiet = FALSE) } \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} \item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} } \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 \emph{$SubCritNames } \tab [character] names of the sub-criteria \cr \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 26  \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 27 28 29 30 31 32  } } \description{ Function which computes an error criterion based on the KGE' formula proposed by Kling et al. (2012). } \details{  Delaigue Olivier committed Dec 09, 2015 33 34 In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised  Delaigue Olivier committed Oct 28, 2015 35 36 37 38 39 40 41 42 43 (e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE). } \examples{ ## see example of the ErrorCrit function } \author{ Laurent Coron (June 2014) } \references{  Delaigue Olivier committed Dec 09, 2015 44 Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),  Delaigue Olivier committed Oct 28, 2015 45 46  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 47  Kling, H., Fuchs, M. and Paulin, M. (2012),  Delaigue Olivier committed Oct 28, 2015 48 49 50 51 52 53 54  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. } \seealso{ \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}}, \code{\link{ErrorCrit_KGE}} }