SimGR.R 3.85 KB
Newer Older
1
SimGR <- function(PrepGR, CalGR = NULL, Param, EffCrit = c("NSE", "KGE", "KGE2", "RMSE"),
unknown's avatar
unknown committed
2
3
                  WupPer = NULL, SimPer, transfo = c("", "sqrt", "log", "inv", "sort"), verbose = TRUE) {
 
4
5
  if (! any(class(PrepGR) %in% "PrepGR")) {
    stop("Non convenient data for argument \"PrepGR\". Must be of class \"PrepGR\"")
unknown's avatar
unknown committed
6
7
  }
  
8
9
10
11
12
  isQobs <- !all(is.na(PrepGR$Qobs))
  if (!isQobs) {
    warning("\"PrepGR\" does not contain any Qobs values. The efficiency criterion is not computed")
  }
  
13
14
15
16
17
18
19
  if (!missing(CalGR)) {
    warning("Deprecated \"CalGR\" argument. Use \"Param\" instead")
  }
  ### to remove when the CalGR will be removed
  if (missing(Param)) {
    Param <- NULL
  }
unknown's avatar
unknown committed
20
21
22
23
  if (! any(class(CalGR) %in% "CalGR") & !is.null(CalGR)) {
    stop("Non convenient data  for argument \"CalGR\". Must be of class \"CalGR\"")
  }
  if (is.null(CalGR) & is.null(Param)) {
24
    stop("Arguments \"CalGR\" and \"Param\" are missing, with no default. You must fill in one of these two arguments")
unknown's avatar
unknown committed
25
26
27
28
  }
  if (is.null(Param)) {
    Param <- CalGR$OutputsCalib$ParamFinalR
  }
29
30
31
32
  ###
  if (inherits(Param, "CalGR")) {
    Param <- Param$OutputsCalib$ParamFinalR
  }
unknown's avatar
unknown committed
33
34
35
36
  
  WupInd <- NULL
  if (!is.null(WupPer)) {
    WupPer <- as.POSIXct(WupPer, tz = "UTC")
37
38
39
    if (length(WupPer) != 2) {
      stop("Warm-up period \"WupPer\" must be of length 2")
    }
unknown's avatar
unknown committed
40
41
42
    if (any(is.na(WupPer))) {
      stop("Non convenient date format for the warm-up period \"WupPer\"")
    } else {
43
      if (!any(PrepGR$InputsModel$DatesR == WupPer[1]) | !any(PrepGR$InputsModel$DatesR == WupPer[2])) {
unknown's avatar
unknown committed
44
45
        stop("Non convenient date for the warm-up period \"WupPer\"")
      } else {
46
        WupInd <- which(PrepGR$InputsModel$DatesR == WupPer[1]):which(PrepGR$InputsModel$DatesR == WupPer[2])
unknown's avatar
unknown committed
47
48
49
50
51
      }
    }
  }
 
  SimPer <- as.POSIXct(SimPer, tz = "UTC")
52
53
54
  if (length(SimPer) != 2) {
    stop("Simulation period \"SimPer\" must be of length 2")
  }
unknown's avatar
unknown committed
55
56
57
  if (any(is.na(SimPer))) {
    stop("Non convenient date format for the simulation period \"SimPer\"")
  } else {
58
    if (!any(PrepGR$InputsModel$DatesR == SimPer[1]) | !any(PrepGR$InputsModel$DatesR == SimPer[2])) {
unknown's avatar
unknown committed
59
60
      stop("Non convenient date for the simulation period \"SimPer\"")
    } else {
61
      SimInd <- which(PrepGR$InputsModel$DatesR == SimPer[1]):which(PrepGR$InputsModel$DatesR == SimPer[2])
unknown's avatar
unknown committed
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
    }
  }
  
  if (! any(EffCrit %in% c("NSE", "KGE", "KGE2", "RMSE"))) {
    stop("Non convenient efficiency criteria \"EffCrit\"")
  } else {
    EffCrit <- EffCrit[1L]
    EffCrit <- sprintf("ErrorCrit_%s", EffCrit)
    FUN_CRIT <- get(EffCrit)
  }
  
  if (! any(transfo %in% c("", "sqrt", "log", "inv", "sort"))) {
    stop("Non convenient transformation \"transfo\"")
  } else {
    transfo <- transfo[1L]
77
78
79
  }

  
unknown's avatar
unknown committed
80
  
81
  MOD_opt <- CreateRunOptions(FUN_MOD = get(PrepGR$TypeModel), InputsModel = PrepGR$InputsModel, 
unknown's avatar
unknown committed
82
83
84
                              IndPeriod_WarmUp = WupInd, IndPeriod_Run = SimInd, verbose = verbose)

  
85
  if (isQobs) {
86
  MOD_crt <- CreateInputsCrit(FUN_CRIT = FUN_CRIT, InputsModel = PrepGR$InputsModel, 
87
88
89
90
                              RunOptions = MOD_opt, Obs = PrepGR$Qobs[SimInd], transfo = transfo)
  } else {
    MOD_crt <- NULL
  }
unknown's avatar
unknown committed
91
92
  
  
93
  SIM <- RunModel(InputsModel = PrepGR$InputsModel, RunOptions = MOD_opt, 
94
                  Param = Param, FUN_MOD = get(PrepGR$TypeModel))
unknown's avatar
unknown committed
95
96
  
  
97
98
99
100
101
102
  if (isQobs) {
    CRT <- ErrorCrit(InputsCrit = MOD_crt, OutputsModel = SIM, verbose = verbose)
  } else {
    CRT <- NULL
  }
  
unknown's avatar
unknown committed
103
  
104
105
  SimGR <- list(OptionsSimul = MOD_opt, OptionsCrit = MOD_crt, OutputsModel = SIM, Qobs = PrepGR$Qobs[SimInd],
                TypeModel = PrepGR$TypeModel,
unknown's avatar
unknown committed
106
                CalCrit = CalGR$CalCrit, EffCrit = CRT,
107
                PeriodModel = list(WarmUp = as.POSIXct(PrepGR$InputsModel$DatesR[range(MOD_opt$IndPeriod_WarmUp)], tz = "UTC"),
unknown's avatar
unknown committed
108
                                   Run    = SimPer))
109
  class(SimGR) <- c("SimGR", "GR", "airGRt")
unknown's avatar
unknown committed
110
111
112
  return(SimGR)  
  
}