v1.6.3.16 docs: CreateRunOptions and CreateInputsCrit man updated to exaplain...

v1.6.3.16 docs: CreateRunOptions and CreateInputsCrit man updated to exaplain how to manage with calibration on discontinuous periods
Refs #63

DESCRIPTION

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

NEWS.md

@@ -2,7 +2,7 @@
 
 
 
-### 1.6.3.15 Release Notes (2020-10-15)
+### 1.6.3.16 Release Notes (2020-10-15)
 
 #### New features
 

man/CreateInputsCrit.Rd

@@ -35,7 +35,7 @@ CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions,
 
 \item{VarObs}{(optional) [character (atomic or list)] names of the observed variable (\code{"Q"} by default, or one of \code{"SCA"}, \code{"SWE"}])}
 
-\item{BoolCrit}{(optional) [boolean (atomic or list)] boolean (the same length as \code{Obs}) giving the time steps to consider in the computation (all time steps are considered by default)}
+\item{BoolCrit}{(optional) [boolean (atomic or list)] boolean (the same length as \code{Obs}) giving the time steps to consider in the computation (all time steps are considered by default. See details)}
 
 \item{transfo}{(optional) [character (atomic or list)] name of the transformation applied to the variables (e.g. \code{""}, \code{"sqrt"}, \code{"log"}, \code{"inv"}, \code{"sort"}, \code{"boxcox"} or a numeric value for power transformation (see details))}
 
@@ -73,6 +73,10 @@ To calculate composite or multiple criteria, it is necessary to use the \code{Er
 \details{
 Users wanting to use \code{FUN_CRIT} functions that are not included in the package must create their own InputsCrit object accordingly. \cr \cr
 
+## ---- Period of calculation
+
+Criteria can be calculated over discontinuous periods (i.e. only over winter periods, or when observed discharge is below a certain threshold). To do so, please indicate in \code{Bool_Crit} which indices must be used for calcullation. Discontinuous periods are allowed in the \code{Bool_Crit} argument.
+
 ## ---- Transformations
 
 Transformations are simple functions applied to the observed and simulated variables used in order to change their distribution. Transformations are often used in hydrology for modifying the weight put on errors made for high flows or low flows. The following transformations are available: \cr \cr

man/CreateRunOptions.Rd

@@ -28,13 +28,13 @@ CreateRunOptions(FUN_MOD, InputsModel,
 
 \item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
 
-\item{IndPeriod_WarmUp}{(optional) [numeric] index of period to be used for the model warm-up [-]}
+\item{IndPeriod_WarmUp}{(optional) [numeric] index of period to be used for the model warm-up [-]. See details}
 
-\item{IndPeriod_Run}{[numeric] index of period to be used for the model run [-]}
+\item{IndPeriod_Run}{[numeric] index of period to be used for the model run [-]. See details}
 
 \item{IniStates}{(optional) [numeric] object of class \code{IniStates} [mm and °C], see \code{\link{CreateIniStates}} for details}
 
-\item{IniResLevels}{(optional) [numeric] vector of initial fillings for the GR stores (2 or 3 values according to the model) [- and/or mm]; see details}
+\item{IniResLevels}{(optional) [numeric] vector of initial fillings for the GR stores (2 or 3 values according to the model) [- and/or mm]. See details}
 
 \item{Imax}{(optional) [numeric] an atomic vector of the maximum capacity of the GR5H interception store [mm]; see \code{\link{RunModel_GR5H}}}
 
@@ -72,6 +72,10 @@ CreateRunOptions(FUN_MOD, InputsModel,
 Users wanting to use \code{FUN_MOD} functions that are not included in 
 the package must create their own \code{RunOptions} object accordingly.
 
+## ---- IndPeriod_WarmUp and IndPeriod_Run
+
+Since the hydrological models included in airGR are continuous models, meaning that internal states of the models are propagated to the next time step, \code{IndPeriod_WarmUp} and \code{IndPeriod_Run} must be continuous periods, represented by continuous indices values; no gaps are allowed. To calculate criteria or to calibrate a model over discontinuous periods, please see the \code{Bool_Crit} argument of the \code{\link{CreateInputsCrit}} function.
+
 ## ---- Initialisation options
 
 The model initialisation options can either be set to a default configuration or be defined by the user.