v1.1.2.8 NEW: add an example in the doc of ErrorCrit_RMSE

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.1.2.7
+Version: 1.1.2.8
 Date: 2018-10-22
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),

man/ErrorCrit_RMSE.Rd

@@ -35,7 +35,7 @@ ErrorCrit_RMSE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
 
 
 \description{
-Function which computes an error criterion based on the root mean square error (RMSE).
+Function which computes an error criterion based on the root-mean-square error (RMSE).
 }
 
 
@@ -47,7 +47,47 @@ the use of the function for model calibration: the product CritValue * Multiplie
 
 
 \examples{
-## see example of the ErrorCrit function
+library(airGR)
+
+## loading catchment data
+data(L0123001)
+
+## preparation of the InputsModel object
+InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4J, DatesR = BasinObs$DatesR, 
+                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
+
+## run period selection
+Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y")=="01/01/1990"), 
+               which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y")=="31/12/1999"))
+
+## preparation of the RunOptions object
+RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR4J,
+                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
+
+## simulation
+Param <- c(734.568, -0.840, 109.809, 1.971)
+OutputsModel <- RunModel(InputsModel = InputsModel, RunOptions = RunOptions, 
+                         Param = Param, FUN = RunModel_GR4J)
+
+## efficiency criterion: root-mean-square error
+InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_RMSE, InputsModel = InputsModel, 
+                               RunOptions = RunOptions, obs = BasinObs$Qmm[Ind_Run])
+OutputsCrit <- ErrorCrit_RMSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
+
+## efficiency criterion: root-mean-square error on log-transformed flows
+transfo <- "log"
+InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_RMSE, InputsModel = InputsModel, 
+                               RunOptions = RunOptions, obs = BasinObs$Qmm[Ind_Run],
+                               transfo = transfo)
+OutputsCrit <- ErrorCrit_RMSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
+
+## efficiency criterion: root-mean-square error above a threshold (q75\%)
+BoolCrit <- rep(TRUE, length(BasinObs$Qmm[Ind_Run])); 
+BoolCrit[BasinObs$Qmm[Ind_Run]<quantile(BasinObs$Qmm[Ind_Run], 0.75, na.rm = TRUE)] <- FALSE
+InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_RMSE, InputsModel = InputsModel, 
+                               RunOptions = RunOptions, obs = BasinObs$Qmm[Ind_Run],
+                               BoolCrit = BoolCrit)
+OutputsCrit <- ErrorCrit_RMSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
 }