v1.4.3.20 DOC: minor revision in Imax, RunModel_GR5H and RunModel_CemaNeigeGR5H doc #13

run RunModel_GR5H example
new parameter values in RunModel_GR5H
new teste values of Imax in Imax, RunModel_GR5H and RunModel_CemaNeigeGR5H
 new see alsso part in  RunModel_GR5H and RunModel_CemaNeigeGR5H

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.4.3.19
+Version: 1.4.3.20
 Date: 2019-12-18
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),

NEWS.md

@@ -2,7 +2,7 @@
 
 
 
-### 1.4.3.19 Release Notes (2019-12-18)
+### 1.4.3.20 Release Notes (2019-12-18)
 
 
 #### New features

man/Imax.Rd

@@ -44,18 +44,18 @@ InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR5H, DatesR = BasinObs$Date
 
 ## run period selection
 Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2004-03-01 00:00"),
-               which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2008-12-31 23:00"))
+               which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2006-12-31 23:00"))
                
 ## Imax computation
 Imax <- Imax(InputsModel = InputsModel, IndPeriod_Run = Ind_Run,
-             TestedValues = seq(from = 0.1, to = 3, by = 1))
+             TestedValues = seq(from = 0, to = 3, by = 0.2))
 
 ## preparation of the RunOptions object
 RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR5H, Imax = Imax,
                                InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
 
 ## simulation
-Param <- c(X1 = 680.673, X2 = -0.255, X3 = 197.651, X4 = 2.384, X5 = 0.174)
+Param <- c(X1 = 706.912, X2 = -0.163, X3 = 188.880, X4 = 2.575, X5 = 0.104)
 OutputsModel <- RunModel_GR5H(InputsModel = InputsModel,
                               RunOptions = RunOptions, Param = Param)
 

man/RunModel_CemaNeigeGR5H.Rd

@@ -110,7 +110,7 @@ Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2
 
 ## Imax computation
 Imax <- Imax(InputsModel = InputsModel, IndPeriod_Run = Ind_Run,
-             TestedValues = seq(from = 0.1, to = 3, by = 0.1))
+             TestedValues = seq(from = 0, to = 3, by = 0.2))
 
 ## preparation of the RunOptions object
 RunOptions <- CreateRunOptions(FUN_MOD = RunModel_CemaNeigeGR5H, InputsModel = InputsModel, 
@@ -169,8 +169,7 @@ Valéry, A., V. Andréassian and C. Perrin (2014).
 
 
 \seealso{
-\code{\link{RunModel_CemaNeige}}, \code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{RunModel_CemaNeigeGR5J}},
-\code{\link{RunModel_CemaNeigeGR6J}}, \code{\link{RunModel_GR5H}}, \code{\link{Imax}},
+\code{\link{RunModel_CemaNeige}}, \code{\link{RunModel_CemaNeigeGR4H}}, \code{\link{RunModel_GR5H}}, \code{\link{Imax}},
 \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
 }
 

man/RunModel_GR5H.Rd

@@ -74,7 +74,6 @@ For further details on the argument structures and initialisation options, see \
 
 
 \examples{
-\dontrun{
 library(airGR)
 
 ## load of catchment data
@@ -86,18 +85,18 @@ InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR5H, DatesR = BasinObs$Date
 
 ## run period selection
 Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2004-03-01 00:00"),
-               which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2008-12-31 23:00"))
+               which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2006-12-31 23:00"))
 
 ## Imax computation
 Imax <- Imax(InputsModel = InputsModel, IndPeriod_Run = Ind_Run,
-             TestedValues = seq(from = 0.1, to = 3, by = 0.1))
+             TestedValues = seq(from = 0, to = 3, by = 0.2))
 
 ## preparation of the RunOptions object
 RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR5H, Imax = Imax,
                                InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
 
 ## simulation
-Param <- c(X1 = 212.284 X2 = -0.018, X3 = 173.449, X4 = 6.629, X5 = 0.051)
+Param <- c(X1 = 706.912, X2 = -0.163, X3 = 188.880, X4 = 2.575, X5 = 0.104)
 OutputsModel <- RunModel_GR5H(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param)
 
 ## results preview
@@ -108,7 +107,6 @@ InputsCrit  <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsMo
                                 RunOptions = RunOptions, Obs = BasinObs$Qmm[Ind_Run])
 OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
 }
-}
 
 
 \author{
@@ -129,8 +127,7 @@ Ficchi, A., C. Perrin and V. Andréassian (2019).
 
 
 \seealso{
-\code{\link{RunModel_GR5J}}, \code{\link{RunModel_GR4H}},
-\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
-\code{\link{CreateIniStates}}, \code{\link{Imax}}, \code{\link{RunModel_CemaNeigeGR5J}}.
+\code{\link{RunModel_GR4H}}, \code{\link{RunModel_CemaNeigeGR5H}}, \code{\link{Imax}},
+\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
 }