ErrorCrit_RMSE.R 4.5 KB
Newer Older
1
ErrorCrit_RMSE <- function(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE) {
2
3
4
5
  
  
  ##Arguments_check________________________________
  if (!inherits(InputsCrit, "InputsCrit")) {
6
    stop("'InputsCrit' must be of class 'InputsCrit'")
7
8
  }
  if (inherits(InputsCrit, "Multi") | inherits(InputsCrit, "Compo")) {
9
    stop("'InputsCrit' must be of class 'Single'. Use the 'ErrorCrit' function on objects of class 'Multi' with RMSE")
10
11
  }
  if (!inherits(OutputsModel, "OutputsModel")) {
12
    stop("'OutputsModel' must be of class 'OutputsModel'")
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
  }
  
  
  ##Initialisation_________________________________
  CritName <- NA
  CritVar  <- InputsCrit$varObs
  if (InputsCrit$transfo == "") {
    CritName <- "RMSE[CritVar]"
  }
  if (InputsCrit$transfo == "sqrt") {
    CritName <- "RMSE[sqrt(CritVar)]"
  }
  if (InputsCrit$transfo == "log") {
    CritName <- "RMSE[log(CritVar)]"
  }
  if (InputsCrit$transfo == "inv") {
    CritName <- "RMSE[1/CritVar]"
  }
  if (InputsCrit$transfo == "sort") {
    CritName <- "RMSE[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_______________________________
42
  VarObs <- InputsCrit$Obs
43
  VarObs[!InputsCrit$BoolCrit] <- NA
44
45
46
47
  if (InputsCrit$varObs == "Q") {
    VarSim <- OutputsModel$Qsim
  }
  if (InputsCrit$varObs == "SCA") {
48
    VarSim <- rowMeans(sapply(OutputsModel$CemaNeigeLayers[InputsCrit$idLayer], FUN = "[[", "Gratio"))
49
50
  }
  if (InputsCrit$varObs == "SWE") {
51
    VarSim <- rowMeans(sapply(OutputsModel$CemaNeigeLayers[InputsCrit$idLayer], FUN = "[[", "SnowPack"))
52
  }
53
54
55
56
57
  VarSim[!InputsCrit$BoolCrit] <- NA
  
  ##Data_transformation
  if (InputsCrit$transfo %in% c("log", "inv") & is.null(InputsCrit$epsilon) & warnings) {
    if (any(VarObs %in% 0)) {
58
      warning("zeroes detected in 'Qobs': the corresponding time-steps will be excluded from the criteria computation if the epsilon argument of 'CreateInputsCrit' = NULL")
59
60
    }
    if (any(VarSim %in% 0)) {
61
      warning("zeroes detected in 'Qsim': the corresponding time-steps will be excluded from the criteria computation if the epsilon argument of 'CreateInputsCrit' = NULL")
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
    }  
  }
  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")
99
    return(OutputsCrit)
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
  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")
  }
  
  
  ##ErrorCrit______________________________________
  Numer <- sum((VarSim - VarObs)^2, na.rm = TRUE)
  Denom <- sum(!is.na(VarObs))
  
  if (Numer == 0) {
    Crit <- 0
  } else {
    Crit <- sqrt(Numer / Denom)
  }
  if (is.numeric(Crit) & is.finite(Crit)) {
    CritValue <- Crit
  }
  
  
  ##Verbose______________________________________
  if (verbose) {
    message("Crit. ", CritName, " = ", sprintf("%.4f", CritValue), "\n")
  }
  
  
  ##Output_________________________________________
  OutputsCrit <- list(CritValue       = CritValue,
                      CritName        = CritName,
                      CritBestValue   = CritBestValue,
                      Multiplier      = Multiplier,
                      Ind_notcomputed = Ind_TS_ignore
  )
  
  class(OutputsCrit) <- c("RMSE", "ErrorCrit")
  return(OutputsCrit)
  
}