diff --git a/DESCRIPTION b/DESCRIPTION index 7912ca65615afc7718a9092be1d699e3fefe7359..58a9f99661c4109183d6dac646b9b3103c833083 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.8 +Version: 1.2.14.9 Date: 2019-04-17 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 e6bd974b585864263bd773c5802373d928e8f99c..8455981117f9966385b46a431607536e10a86c91 100644 --- a/NEWS.rmd +++ b/NEWS.rmd @@ -14,7 +14,7 @@ output: -### 1.2.14.8 Release Notes (2019-04-17) +### 1.2.14.9 Release Notes (2019-04-17) #### New features diff --git a/R/ErrorCrit_KGE.R b/R/ErrorCrit_KGE.R index 783decb6423abf61d34b77d5b62eff4c333e5e99..fcba7fd7b9d6116d7a0cfc1121c54c72c94447cb 100644 --- a/R/ErrorCrit_KGE.R +++ b/R/ErrorCrit_KGE.R @@ -5,15 +5,16 @@ ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T stop("'OutputsModel' must be of class 'OutputsModel'") } - OutputsCritCheck <- .ErrorCrit(InputsCrit = InputsCrit, crit = "KGE") + EC <- .ErrorCrit(InputsCrit = InputsCrit, Crit = "KGE", OutputsModel = OutputsModel, warnings = warnings) - - if (!OutputsCritCheck$CritCompute) { - CritValue <- NA + if (!EC$CritCompute) { + CritValue <- NA + SubCritValues <- NA + SubCritNames <- NA } else { ## Other variables preparation - meanVarObs <- mean(VarObs[!TS_ignore]) - meanVarSim <- mean(VarSim[!TS_ignore]) + meanVarObs <- mean(EC$VarObs[!EC$TS_ignore]) + meanVarSim <- mean(EC$VarSim[!EC$TS_ignore]) iCrit <- 0 SubCritPrint <- NULL @@ -22,13 +23,13 @@ ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T ## SubErrorCrit KGE rPearson iCrit <- iCrit + 1 - SubCritPrint[iCrit] <- paste(CritName, " cor(sim, obs, \"pearson\") =", sep = "") + SubCritPrint[iCrit] <- paste0(EC$CritName, " cor(sim, obs, \"pearson\") =") 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)) + Numer <- sum((EC$VarObs[!EC$TS_ignore] - meanVarObs) * (EC$VarSim[!EC$TS_ignore] - meanVarSim)) + Deno1 <- sqrt(sum((EC$VarObs[!EC$TS_ignore] - meanVarObs) ^ 2)) + Deno2 <- sqrt(sum((EC$VarSim[!EC$TS_ignore] - meanVarSim) ^ 2)) if (Numer == 0) { if (Deno1 == 0 & Deno2 == 0) { @@ -45,12 +46,12 @@ ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T ## SubErrorCrit KGE alpha iCrit <- iCrit + 1 - SubCritPrint[iCrit] <- paste(CritName, " sd(sim)/sd(obs) =", sep = "") + SubCritPrint[iCrit] <- paste0(EC$CritName, " sd(sim)/sd(obs) =") SubCritValues[iCrit] <- NA SubCritNames[iCrit] <- "alpha" - Numer <- sd(VarSim[!TS_ignore]) - Denom <- sd(VarObs[!TS_ignore]) + Numer <- sd(EC$VarSim[!EC$TS_ignore]) + Denom <- sd(EC$VarObs[!EC$TS_ignore]) if (Numer == 0 & Denom == 0) { Crit <- 1 @@ -63,7 +64,7 @@ ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T ## SubErrorCrit KGE beta iCrit <- iCrit + 1 - SubCritPrint[iCrit] <- paste(CritName, " mean(sim)/mean(obs) =", sep = "") + SubCritPrint[iCrit] <- paste0(EC$CritName, " mean(sim)/mean(obs) =") SubCritValues[iCrit] <- NA SubCritNames[iCrit] <- "beta" @@ -83,7 +84,7 @@ ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T ## Verbose if (verbose) { - message("Crit. ", CritName, " = ", sprintf("%.4f", CritValue)) + message(sprintf("Crit. %s = %.4f", EC$CritName, CritValue)) message(paste("\tSubCrit.", SubCritPrint, sprintf("%.4f", SubCritValues), "\n", sep = " ")) } } @@ -91,13 +92,12 @@ ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T ## Output OutputsCrit <- list(CritValue = CritValue, - CritName = CritName, + CritName = EC$CritName, SubCritValues = SubCritValues, SubCritNames = SubCritNames, - CritBestValue = CritBestValue, - Multiplier = Multiplier, - Ind_notcomputed = Ind_TS_ignore - ) + CritBestValue = EC$CritBestValue, + Multiplier = EC$Multiplier, + Ind_notcomputed = EC$Ind_TS_ignore) class(OutputsCrit) <- c("KGE", "ErrorCrit") return(OutputsCrit) diff --git a/R/ErrorCrit_KGE2.R b/R/ErrorCrit_KGE2.R index 694bffa0e1ece310cb3801f8941fe5877e12020a..e2f51e28a3376cd9641668950465a0ab4cf198af 100644 --- a/R/ErrorCrit_KGE2.R +++ b/R/ErrorCrit_KGE2.R @@ -5,14 +5,14 @@ ErrorCrit_KGE2 <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = stop("'OutputsModel' must be of class 'OutputsModel'") } - OutputsCritCheck <- .ErrorCrit(InputsCrit = InputsCrit, crit = "RMSE") + EC <- .ErrorCrit(InputsCrit = InputsCrit, Crit = "KGE2", OutputsModel = OutputsModel, warnings = warnings) - if (!OutputsCritCheck$CritCompute) { + if (!EC$CritCompute) { CritValue <- NA } else { ## Other variables preparation - meanVarObs <- mean(VarObs[!TS_ignore]) - meanVarSim <- mean(VarSim[!TS_ignore]) + meanVarObs <- mean(EC$VarObs[!EC$TS_ignore]) + meanVarSim <- mean(EC$VarSim[!EC$TS_ignore]) iCrit <- 0 SubCritPrint <- NULL @@ -21,13 +21,13 @@ ErrorCrit_KGE2 <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = ## SubErrorCrit KGE rPearson iCrit <- iCrit + 1 - SubCritPrint[iCrit] <- paste(CritName, " cor(sim, obs, \"pearson\") =", sep = "") + SubCritPrint[iCrit] <- paste0(EC$CritName, " cor(sim, obs, \"pearson\") =") 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)) + Numer <- sum((EC$VarObs[!EC$TS_ignore] - meanVarObs) * (EC$VarSim[!EC$TS_ignore] - meanVarSim)) + Deno1 <- sqrt(sum((EC$VarObs[!EC$TS_ignore] - meanVarObs)^2)) + Deno2 <- sqrt(sum((EC$VarSim[!EC$TS_ignore] - meanVarSim)^2)) if (Numer == 0) { if (Deno1 == 0 & Deno2 == 0) { @@ -44,28 +44,28 @@ ErrorCrit_KGE2 <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = ## SubErrorCrit KGE gamma iCrit <- iCrit + 1 - SubCritPrint[iCrit] <- paste(CritName, " cv(sim)/cv(obs) =", sep = "") + SubCritPrint[iCrit] <- paste0(EC$CritName, " cv(sim)/cv(obs) =") SubCritValues[iCrit] <- NA SubCritNames[iCrit] <- "gamma" if (meanVarSim == 0) { - if (sd(VarSim[!TS_ignore]) == 0) { + if (sd(EC$VarSim[!EC$TS_ignore]) == 0) { CVsim <- 1 } else { CVsim <- 99999 } } else { - CVsim <- sd(VarSim[!TS_ignore]) / meanVarSim + CVsim <- sd(EC$VarSim[!EC$TS_ignore]) / meanVarSim } if (meanVarObs == 0) { - if (sd(VarObs[!TS_ignore]) == 0) { + if (sd(EC$VarObs[!EC$TS_ignore]) == 0) { CVobs <- 1 } else { CVobs <- 99999 } } else { - CVobs <- sd(VarObs[!TS_ignore]) / meanVarObs + CVobs <- sd(EC$VarObs[!EC$TS_ignore]) / meanVarObs } if (CVsim == 0 & CVobs == 0) { @@ -79,7 +79,7 @@ ErrorCrit_KGE2 <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = ## SubErrorCrit KGE beta iCrit <- iCrit + 1 - SubCritPrint[iCrit] <- paste(CritName, " mean(sim)/mean(obs) =", sep = "") + SubCritPrint[iCrit] <- paste0(EC$CritName, " mean(sim)/mean(obs) =") SubCritValues[iCrit] <- NA SubCritNames[iCrit] <- "beta" @@ -99,7 +99,7 @@ ErrorCrit_KGE2 <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = ## Verbose if (verbose) { - message("Crit. ", CritName, " = ", sprintf("%.4f", CritValue)) + message(sprintf("Crit. %s = %.4f", EC$CritName, CritValue)) message(paste("\tSubCrit.", SubCritPrint, sprintf("%.4f", SubCritValues), "\n", sep = " ")) } } @@ -107,12 +107,12 @@ ErrorCrit_KGE2 <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = ## Output OutputsCrit <- list(CritValue = CritValue, - CritName = CritName, + CritName = EC$CritName, SubCritValues = SubCritValues, SubCritNames = SubCritNames, - CritBestValue = CritBestValue, - Multiplier = Multiplier, - Ind_notcomputed = Ind_TS_ignore) + CritBestValue = EC$CritBestValue, + Multiplier = EC$Multiplier, + Ind_notcomputed = EC$Ind_TS_ignore) class(OutputsCrit) <- c("KGE2", "ErrorCrit") return(OutputsCrit) diff --git a/R/ErrorCrit_NSE.R b/R/ErrorCrit_NSE.R index 72c2205168f5341a720bf2648df4dcd70c5e1187..899dcc6fe575124e2d769cb0337dd9c1a9a8bcd1 100644 --- a/R/ErrorCrit_NSE.R +++ b/R/ErrorCrit_NSE.R @@ -5,18 +5,18 @@ ErrorCrit_NSE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T stop("'OutputsModel' must be of class 'OutputsModel'") } - OutputsCritCheck <- .ErrorCrit(InputsCrit = InputsCrit, crit = "NSE") + EC <- .ErrorCrit(InputsCrit = InputsCrit, Crit = "NSE", OutputsModel = OutputsModel, warnings = warnings) - if (!OutputsCritCheck$CritCompute) { + if (!EC$CritCompute) { CritValue <- NA } else { ## Other variables preparation - meanVarObs <- mean(VarObs[!TS_ignore]) - meanVarSim <- mean(VarSim[!TS_ignore]) + meanVarObs <- mean(EC$VarObs[!EC$TS_ignore]) + meanVarSim <- mean(EC$VarSim[!EC$TS_ignore]) ## ErrorCrit - Emod <- sum((VarSim[!TS_ignore] - VarObs[!TS_ignore])^2) - Eref <- sum((VarObs[!TS_ignore] - mean(VarObs[!TS_ignore]))^2) + Emod <- sum((EC$VarSim[!EC$TS_ignore] - EC$VarObs[!EC$TS_ignore])^2) + Eref <- sum((EC$VarObs[!EC$TS_ignore] - mean(EC$VarObs[!EC$TS_ignore]))^2) if (Emod == 0 & Eref == 0) { Crit <- 0 @@ -29,17 +29,17 @@ ErrorCrit_NSE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = T ## Verbose if (verbose) { - message("Crit. ", CritName, " = ", sprintf("%.4f", CritValue), "\n") + message(sprintf("Crit. %s = %.4f", EC$CritName, CritValue)) } } ## Output OutputsCrit <- list(CritValue = CritValue, - CritName = CritName, - CritBestValue = CritBestValue, - Multiplier = Multiplier, - Ind_notcomputed = Ind_TS_ignore) + CritName = EC$CritName, + CritBestValue = EC$CritBestValue, + Multiplier = EC$Multiplier, + Ind_notcomputed = EC$Ind_TS_ignore) class(OutputsCrit) <- c("NSE", "ErrorCrit") return(OutputsCrit) diff --git a/R/ErrorCrit_RMSE.R b/R/ErrorCrit_RMSE.R index 173f875791fb1e1aa997cde243ca0102e65fc747..424b07579f60e7fffd42cbd8d555390cf241c2e8 100644 --- a/R/ErrorCrit_RMSE.R +++ b/R/ErrorCrit_RMSE.R @@ -5,14 +5,14 @@ ErrorCrit_RMSE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = stop("'OutputsModel' must be of class 'OutputsModel'") } - OutputsCritCheck <- .ErrorCrit(InputsCrit = InputsCrit, crit = "RMSE") + EC <- .ErrorCrit(InputsCrit = InputsCrit, Crit = "RMSE", OutputsModel = OutputsModel, warnings = warnings) - if (!OutputsCritCheck$CritCompute) { + if (!EC$CritCompute) { CritValue <- NA } else { ## ErrorCrit - Numer <- sum((OutputsCritCheck$VarSim - OutputsCritCheck$VarObs)^2, na.rm = TRUE) - Denom <- sum(!is.na(OutputsCritCheck$VarObs)) + Numer <- sum((EC$VarSim - EC$VarObs)^2, na.rm = TRUE) + Denom <- sum(!is.na(EC$VarObs)) if (Numer == 0) { Crit <- 0 @@ -25,17 +25,17 @@ ErrorCrit_RMSE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = ## Verbose if (verbose) { - message("Crit. ", OutputsCritCheck$CritName, " = ", sprintf("%.4f", CritValue), "\n") + message(sprintf("Crit. %s = %.4f", EC$CritName, CritValue)) } } ## Output OutputsCrit <- list(CritValue = CritValue, - CritName = OutputsCritCheck$CritName, - CritBestValue = OutputsCritCheck$CritBestValue, - Multiplier = OutputsCritCheck$Multiplier, - Ind_notcomputed = OutputsCritCheck$Ind_TS_ignore) + CritName = EC$CritName, + CritBestValue = EC$CritBestValue, + Multiplier = EC$Multiplier, + Ind_notcomputed = EC$Ind_TS_ignore) class(OutputsCrit) <- c("RMSE", "ErrorCrit") return(OutputsCrit)