ErrorCrit_KGE.R 6.66 KB
Newer Older
1
ErrorCrit_KGE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE) {
2
3
  
  
4
    ##Arguments_check________________________________
5
    if (!inherits(InputsCrit, "InputsCrit")) {
6
7
8
      stop("InputsCrit must be of class 'InputsCrit' \n")
      return(NULL)
    }
9
    if (inherits(InputsCrit, "Multi") | inherits(InputsCrit, "Compo")) {
10
      stop("InputsCrit must be of class 'Single'. Use the ErrorCrit function on objects of class 'Multi' or 'Compo' with KGE")
11
12
      return(NULL)
    }
13
    if (!inherits(OutputsModel, "OutputsModel")) {
14
15
16
17
18
19
20
      stop("OutputsModel must be of class 'OutputsModel' \n")
      return(NULL)
    }
    
    
    ##Initialisation_________________________________
    CritName <- NA
21
    CritVar  <- InputsCrit$varObs
22
    if (InputsCrit$transfo == "") {
23
      CritName <- "KGE[CritVar]"
24
25
    }
    if (InputsCrit$transfo == "sqrt") {
26
      CritName <- "KGE[sqrt(CritVar)]"
27
28
    }
    if (InputsCrit$transfo == "log") {
29
      CritName <- "KGE[log(CritVar)]"
30
31
    }
    if (InputsCrit$transfo == "inv") {
32
      CritName <- "KGE[1/CritVar]"
33
34
    }
    if (InputsCrit$transfo == "sort") {
35
      CritName <- "KGE[sort(CritVar)]"
36
    }
37
38
39
40
    CritName      <- gsub(pattern = "CritVar", replacement = CritVar, x = CritName)
    CritValue     <- NA
    CritBestValue <- +1
    Multiplier    <- -1
41
42
43
44
    ### must be equal to -1 or +1 only
    
    
    ##Data_preparation_______________________________
45
    VarObs <- InputsCrit$obs
46
47
48
49
50
    VarObs[!InputsCrit$BoolCrit] <- NA
    VarSim <- OutputsModel$Qsim
    VarSim[!InputsCrit$BoolCrit] <- NA
    
    ##Data_transformation
51
    if (InputsCrit$transfo %in% c("log", "inv") & is.null(InputsCrit$epsilon) & warnings) {
52
      if (any(VarObs %in% 0)) {
53
        warning("zeroes detected in Qobs: the corresponding time-steps will be excluded from the criteria computation if the epsilon argument of 'CreateInputsCrit' = NULL")
54
55
      }
      if (any(VarSim %in% 0)) {
56
        warning("zeroes detected in Qsim: the corresponding time-steps will be excluded from the criteria computation if the epsilon argument of 'CreateInputsCrit' = NULL")
57
58
      }  
    }
59
60
61
    if ("epsilon" %in% names(InputsCrit) & !is.null(InputsCrit$epsilon)) {
      VarObs <- VarObs + InputsCrit$epsilon
      VarSim <- VarSim + InputsCrit$epsilon
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
    }
    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) {
        Crit <- 1
      } else {
        Crit <- 0
      }
    } 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_________________________________________
    OutputsCrit <- list(CritValue       = CritValue,
                        CritName        = CritName,
                        SubCritValues   = SubCritValues,
                        SubCritNames    = SubCritNames,
                        CritBestValue   = CritBestValue,
                        Multiplier      = Multiplier,
                        Ind_notcomputed = Ind_TS_ignore
    )
207
208
    
    class(OutputsCrit) <- c("KGE", "ErrorCrit")
209
210
211
    return(OutputsCrit)
    
  }