diff --git a/DESCRIPTION b/DESCRIPTION
index 0b39411160d5bc22d26194c63296a18ee9f09bce..208048c80fae165c5bba83da4c220bf950546044 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.2.14.1
+Version: 1.2.14.2
Date: 2019-04-16
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
diff --git a/NEWS.rmd b/NEWS.rmd
index 627ebde8a71c083454a91d0ad0188fb4a12a1547..4c67a637220cc0f60047a54e29f1b96c0b7b1467 100644
--- a/NEWS.rmd
+++ b/NEWS.rmd
@@ -14,7 +14,7 @@ output:
-### 1.2.14.1 Release Notes (2019-04-16)
+### 1.2.14.2 Release Notes (2019-04-16)
#### New features
diff --git a/R/ErrorCrit_KGE.R b/R/ErrorCrit_KGE.R
index f4fb2f5350b0dad08177799d0f02dce8d3280ff2..ead7098014c26fa39d2b6cd4ca6755b75762a985 100644
--- a/R/ErrorCrit_KGE.R
+++ b/R/ErrorCrit_KGE.R
@@ -1,206 +1,95 @@
ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE) {
-
- ##Arguments_check________________________________
- if (!inherits(InputsCrit, "InputsCrit")) {
- stop("'InputsCrit' must be of class 'InputsCrit'")
- }
- if (inherits(InputsCrit, "Multi") | inherits(InputsCrit, "Compo")) {
- stop("'InputsCrit' must be of class 'Single'. Use the 'ErrorCrit' function on objects of class 'Multi' or 'Compo' with KGE")
- }
+ ## Arguments check
if (!inherits(OutputsModel, "OutputsModel")) {
stop("'OutputsModel' must be of class 'OutputsModel'")
}
+ OutputsCritCheck <- .fun_ErrorCrit(InputsCrit = InputsCrit, crit = "KGE")
- ##Initialisation_________________________________
- CritName <- NA
- CritVar <- InputsCrit$VarObs
- if (InputsCrit$transfo == "") {
- CritName <- "KGE[CritVar]"
- }
- if (InputsCrit$transfo == "sqrt") {
- CritName <- "KGE[sqrt(CritVar)]"
- }
- if (InputsCrit$transfo == "log") {
- CritName <- "KGE[log(CritVar)]"
- }
- if (InputsCrit$transfo == "inv") {
- CritName <- "KGE[1/CritVar]"
- }
- if (InputsCrit$transfo == "sort") {
- CritName <- "KGE[sort(CritVar)]"
- }
- CritName <- gsub(pattern = "CritVar", replacement = CritVar, x = CritName)
- CritValue <- NA
- CritBestValue <- +1
- Multiplier <- -1
- ### must be equal to -1 or +1 only
-
-
- ##Data_preparation_______________________________
- VarObs <- InputsCrit$Obs
- VarObs[!InputsCrit$BoolCrit] <- NA
- if (InputsCrit$VarObs == "Q") {
- VarSim <- OutputsModel$Qsim
- }
- if (InputsCrit$VarObs == "SCA") {
- VarSim <- rowMeans(sapply(OutputsModel$CemaNeigeLayers[InputsCrit$idLayer], FUN = "[[", "Gratio"))
- }
- if (InputsCrit$VarObs == "SWE") {
- VarSim <- rowMeans(sapply(OutputsModel$CemaNeigeLayers[InputsCrit$idLayer], FUN = "[[", "SnowPack"))
- }
- VarSim[!InputsCrit$BoolCrit] <- NA
- ##Data_transformation
- if (InputsCrit$transfo %in% c("log", "inv") & is.null(InputsCrit$epsilon) & warnings) {
- if (any(VarObs %in% 0)) {
- warning("zeroes detected in 'Qobs': the corresponding time-steps will be excluded from the criteria computation if the epsilon argument of 'CreateInputsCrit' = NULL")
+ if (!OutputsCritCheck$CritCompute) {
+ CritValue <- NA
+ } else {
+ ## Other variables preparation
+ meanVarObs <- mean(VarObs[!TS_ignore])
+ meanVarSim <- mean(VarSim[!TS_ignore])
+
+ iCrit <- 0
+ SubCritPrint <- NULL
+ SubCritNames <- NULL
+ SubCritValues <- NULL
+
+ ## SubErrorCrit KGE rPearson
+ iCrit <- iCrit + 1
+ SubCritPrint[iCrit] <- paste(CritName, " cor(sim, obs, \"pearson\") =", sep = "")
+ SubCritValues[iCrit] <- NA
+ SubCritNames[iCrit] <- "r"
+
+ Numer <- sum((VarObs[!TS_ignore] - meanVarObs) * (VarSim[!TS_ignore] - meanVarSim))
+ Deno1 <- sqrt(sum((VarObs[!TS_ignore] - meanVarObs) ^ 2))
+ Deno2 <- sqrt(sum((VarSim[!TS_ignore] - meanVarSim) ^ 2))
+
+ if (Numer == 0) {
+ if (Deno1 == 0 & Deno2 == 0) {
+ Crit <- 1
+ } else {
+ Crit <- 0
+ }
+ } else {
+ Crit <- Numer / (Deno1 * Deno2)
}
- if (any(VarSim %in% 0)) {
- warning("zeroes detected in Qsim: the corresponding time-steps will be excluded from the criteria computation if the epsilon argument of 'CreateInputsCrit' = NULL")
- }
- }
- if ("epsilon" %in% names(InputsCrit) & !is.null(InputsCrit$epsilon)) {
- VarObs <- VarObs + InputsCrit$epsilon
- VarSim <- VarSim + InputsCrit$epsilon
- }
- if (InputsCrit$transfo == "sqrt") {
- VarObs <- sqrt(VarObs)
- VarSim <- sqrt(VarSim)
- }
- if (InputsCrit$transfo == "log") {
- VarObs <- log(VarObs)
- VarSim <- log(VarSim)
- VarSim[VarSim < -1e100] <- NA
- }
- if (InputsCrit$transfo == "inv") {
- VarObs <- 1 / VarObs
- VarSim <- 1 / VarSim
- VarSim[abs(VarSim) > 1e+100] <- NA
- }
- if (InputsCrit$transfo == "sort") {
- VarSim[is.na(VarObs)] <- NA
- VarSim <- sort(VarSim, na.last = TRUE)
- VarObs <- sort(VarObs, na.last = TRUE)
- InputsCrit$BoolCrit <- sort(InputsCrit$BoolCrit, decreasing = TRUE)
- }
-
- ##TS_ignore
- TS_ignore <- !is.finite(VarObs) | !is.finite(VarSim) | !InputsCrit$BoolCrit
- Ind_TS_ignore <- which(TS_ignore)
- if (length(Ind_TS_ignore) == 0) {
- Ind_TS_ignore <- NULL
- }
- if (sum(!TS_ignore) == 0) {
- OutputsCrit <- list(NA)
- names(OutputsCrit) <- c("CritValue")
- return(OutputsCrit)
- }
- if (sum(!TS_ignore) == 1) {
- OutputsCrit <- list(NA)
- names(OutputsCrit) <- c("CritValue")
- return(OutputsCrit)
- } ### to avoid a problem in standard deviation computation
- if (inherits(OutputsModel, "hourly")) {
- WarningTS <- 365
- }
- if (inherits(OutputsModel, "daily")) {
- WarningTS <- 365
- }
- if (inherits(OutputsModel, "monthly")) {
- WarningTS <- 12
- }
- if (inherits(OutputsModel, "yearly")) {
- WarningTS <- 3
- }
- if (sum(!TS_ignore) < WarningTS & warnings) {
- warning("\t criterion computed on less than ", WarningTS, " time-steps ")
- }
-
- ##Other_variables_preparation
- meanVarObs <- mean(VarObs[!TS_ignore])
- meanVarSim <- mean(VarSim[!TS_ignore])
-
- iCrit <- 0
- SubCritPrint <- NULL
- SubCritNames <- NULL
- SubCritValues <- NULL
-
-
- ##SubErrorCrit_____KGE_rPearson__________________
- iCrit <- iCrit + 1
- SubCritPrint[iCrit] <- paste(CritName, " cor(sim, obs, \"pearson\") =", sep = "")
- SubCritValues[iCrit] <- NA
- SubCritNames[iCrit] <- "r"
-
- Numer <- sum((VarObs[!TS_ignore] - meanVarObs) * (VarSim[!TS_ignore] - meanVarSim))
- Deno1 <- sqrt(sum((VarObs[!TS_ignore] - meanVarObs) ^ 2))
- Deno2 <- sqrt(sum((VarSim[!TS_ignore] - meanVarSim) ^ 2))
-
- if (Numer == 0) {
- if (Deno1 == 0 & Deno2 == 0) {
+ if (is.numeric(Crit) & is.finite(Crit)) {
+ SubCritValues[iCrit] <- Crit
+ }
+
+ ## SubErrorCrit KGE alpha
+ iCrit <- iCrit + 1
+ SubCritPrint[iCrit] <- paste(CritName, " sd(sim)/sd(obs) =", sep = "")
+ SubCritValues[iCrit] <- NA
+ SubCritNames[iCrit] <- "alpha"
+
+ Numer <- sd(VarSim[!TS_ignore])
+ Denom <- sd(VarObs[!TS_ignore])
+
+ if (Numer == 0 & Denom == 0) {
Crit <- 1
} else {
- Crit <- 0
+ Crit <- Numer / Denom
+ }
+ if (is.numeric(Crit) & is.finite(Crit)) {
+ SubCritValues[iCrit] <- Crit
+ }
+
+ ## SubErrorCrit KGE beta
+ iCrit <- iCrit + 1
+ SubCritPrint[iCrit] <- paste(CritName, " mean(sim)/mean(obs) =", sep = "")
+ SubCritValues[iCrit] <- NA
+ SubCritNames[iCrit] <- "beta"
+
+ if (meanVarSim == 0 & meanVarObs == 0) {
+ Crit <- 1
+ } else {
+ Crit <- meanVarSim / meanVarObs
+ }
+ if (is.numeric(Crit) & is.finite(Crit)) {
+ SubCritValues[iCrit] <- Crit
+ }
+
+ ## ErrorCrit
+ if (sum(is.na(SubCritValues)) == 0) {
+ CritValue <- (1 - sqrt((SubCritValues[1] - 1)^2 + (SubCritValues[2] - 1)^2 + (SubCritValues[3] - 1)^2))
+ }
+
+ ## Verbose
+ if (verbose) {
+ message("Crit. ", CritName, " = ", sprintf("%.4f", CritValue))
+ message(paste("\tSubCrit.", SubCritPrint, sprintf("%.4f", SubCritValues), "\n", sep = " "))
}
- } else {
- Crit <- Numer / (Deno1 * Deno2)
- }
- if (is.numeric(Crit) & is.finite(Crit)) {
- SubCritValues[iCrit] <- Crit
- }
-
-
- ##SubErrorCrit_____KGE_alpha_____________________
- iCrit <- iCrit + 1
- SubCritPrint[iCrit] <- paste(CritName, " sd(sim)/sd(obs) =", sep = "")
- SubCritValues[iCrit] <- NA
- SubCritNames[iCrit] <- "alpha"
-
- Numer <- sd(VarSim[!TS_ignore])
- Denom <- sd(VarObs[!TS_ignore])
-
- if (Numer == 0 & Denom == 0) {
- Crit <- 1
- } else {
- Crit <- Numer / Denom
- }
- if (is.numeric(Crit) & is.finite(Crit)) {
- SubCritValues[iCrit] <- Crit
- }
-
-
- ##SubErrorCrit_____KGE_beta______________________
- iCrit <- iCrit + 1
- SubCritPrint[iCrit] <- paste(CritName, " mean(sim)/mean(obs) =", sep = "")
- SubCritValues[iCrit] <- NA
- SubCritNames[iCrit] <- "beta"
-
- if (meanVarSim == 0 & meanVarObs == 0) {
- Crit <- 1
- } else {
- Crit <- meanVarSim / meanVarObs
- }
- if (is.numeric(Crit) & is.finite(Crit)) {
- SubCritValues[iCrit] <- Crit
- }
-
-
- ##ErrorCrit______________________________________
- if (sum(is.na(SubCritValues)) == 0) {
- CritValue <- (1 - sqrt((SubCritValues[1] - 1)^2 + (SubCritValues[2] - 1)^2 + (SubCritValues[3] - 1)^2))
- }
-
-
- ##Verbose______________________________________
- if (verbose) {
- message("Crit. ", CritName, " = ", sprintf("%.4f", CritValue))
- message(paste("\tSubCrit.", SubCritPrint, sprintf("%.4f", SubCritValues), "\n", sep = " "))
}
- ##Output_________________________________________
+ ## Output
OutputsCrit <- list(CritValue = CritValue,
CritName = CritName,
SubCritValues = SubCritValues,