v1.4.2.17 DOC: revisions of explanations and code corrections in Imax doc

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.4.2.16
+Version: 1.4.2.17
 Date: 2019-12-11
 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.2.16 Release Notes (2019-12-11)
+### 1.4.2.17 Release Notes (2019-12-11)
 
 
 #### New features

man/Imax.Rd

@@ -5,11 +5,11 @@
 \alias{Imax}
 
 
-\title{Compute the maximum capacity of the GR5H interception store}
+\title{Computation of the maximum capacity of the GR5H interception store}
 
 
 \usage{
-Imax(InputsModel, RunOptions, Param)
+Imax(InputsModel, IndPeriod_Run, TestedValues)
 }
 
 
@@ -18,17 +18,17 @@ Imax(InputsModel, RunOptions, Param)
 
 \item{IndPeriod_Run}{numeric] index of period to be used for the model run [-]}
 
-\item{TestedValues}{[numeric] vector of tested Imax values}
+\item{TestedValues}{[numeric] vector of tested Imax values [mm]}
 }
 
 
 \value{
-Choosen Imax value [mm].
+Optimal Imax value [mm].
 }
 
 
 \description{
-Function which performs a single run for the GR4J daily lumped model over the test period.
+Function which calculates the maximal capacity of the GR5H interception store. This function compares the interception evapotranspiration from the GR5H interception store for different maximal capacity values with the interception evapotranspiration classically used in the daily GR models (e.g. GR4J). Among all the \code{TestedValues}, the value that gives the closest interception evapotranspiration flux over the whole period is kept. 
 }
 
 
@@ -46,9 +46,9 @@ InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR5H, DatesR = BasinObs$Date
 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"))
                
-## Imax compuattion
+## Imax computation
 Imax <- Imax(InputsModel = InputsModel, IndPeriod_Run = Ind_Run,
-             TestedValues = seq(from, 0.1, to 3, by = 1))
+             TestedValues = seq(from = 0.1, to = 3, by = 1))
 
 ## preparation of the RunOptions object
 RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR5H, Imax = Imax,