v1.0.9.5 CreateRunOptions documentation updated

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.0.9.4
+Version: 1.0.9.5
 Date: 2017-06-26
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl")),

man/CreateRunOptions.Rd

@@ -17,7 +17,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run,
 
 \item{IndPeriod_Run}{[numeric] index of period to be used for the model run [-]}
 
-\item{IniStates}{(optional) [numeric] vector of initial model internal states [mm]}
+\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}
 
@@ -37,8 +37,8 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run,
          \tabular{ll}{
          \emph{IndPeriod_WarmUp }  \tab  [numeric] index of period to be used for the model warm-up [-] \cr
          \emph{IndPeriod_Run    }  \tab  [numeric] index of period to be used for the model run [-] \cr
-         \emph{IniStates        }  \tab  [numeric] vector of initial model states [mm] \cr
-         \emph{IniResLevels     }  \tab  [numeric] vector of initial filling rates for production and routing stores [-] \cr
+         \emph{IniStates        }  \tab  [numeric] vector of initial model states [mm and °C] \cr
+         \emph{IniResLevels     }  \tab  [numeric] vector of initial filling rates for production and routing stores [-] and level fothe the exponential store for GR6J [mm]\cr
          \emph{Outputs_Cal      }  \tab  [character] character vector giving only the outputs needed for the calibration \cr
          \emph{Outputs_Sim      }  \tab  [character] character vector giving the requested outputs \cr
          \emph{RunSnowModule    }  \tab  [boolean] option indicating whether CemaNeige should be activated \cr
@@ -71,20 +71,17 @@ The actual length of this warm-up might be shorter depending on data availabilit
 (2) Customisation of initialisation options:
 
 \itemize{
-\item \code{IndPeriod_WarmUp} can be used to specify the indices of the warm-up period (within the time-series prepared in InputsModel). \cr
+\item \code{IndPeriod_WarmUp} can be used to specify the indices of the warm-up period (within the time series prepared in InputsModel). \cr
 - remark 1:	for most common cases, indices corresponding to one or several years preceding \code{IndPeriod_Run} are used (e.g. \code{IndPeriod_WarmUp = 1000:1365} and \code{IndPeriod_Run = 1366:5000)}. \cr
 However, it is also possible to perform a long-term initialisation if other indices than the warm-up ones are set in \code{IndPeriod_WarmUp} (e.g. \code{IndPeriod_WarmUp <- c(1:5000 , 1:5000 , 1:5000 , 1000:1365)}). \cr
 - remark 2:	it is also possible to completely disable the warm-up period when using \code{IndPeriod_WarmUp = 0L}. This is necessary if you want \code{IniStates} and / or \code{IniResLevels} to be the actual initial values of the model variables from your simulation (e.g. to perform a forecast form a given initial state). 
 
 \item \code{IniStates} and \code{IniResLevels} can be used to specify the initial model states. \cr
 - remark 1: \code{IniStates} and \code{IniResLevels} can not be used with GR1A. \cr
-- remark 2:	\code{IniStates} can be set to the \code{$StateEnd} output of a previous \code{RunModel} call. \cr
-- remark 3:	if \code{IniStates} is used, all model states must be provided:
-  \itemize{
-  \item 7 values: production store level [mm], routing store level [mm], exponential store level [mm] (only with GR6J, 0 otherwise), and the 4 other values have to be set to 0;
-  \item 60 floats [mm] are required for GR4J, GR5J and GR6J; 60+2*NLayers floats [mm] are required for \code{CemaNeigeGR4J}, \code{CemaNeigeGR5J} and \emph{CemaNeigeGR6J}; see fortran source code for details).
-  }
-- remark 4:	in addition to \code{IniStates}, \code{IniResLevels} allows to set the filling rate of the production and routing stores for the GR models. For instance for GR4J, GR5J and GR6J: \code{IniResLevels <- c(0.3, 0.5)} should be used to obtain initial fillings of 30\% and 50\% for the production and routing stores, respectively. \code{IniResLevels} is optional and can only be used if \code{IniStates} is also defined (the state values corresponding to these two stores in \code{IniStates} are not used in such case). \cr \cr
+- remark 2:	if \code{IniStates} is used, two possibilities are offered:
+   - \code{IniStates} can be set to the \code{$StateEnd} output of a previous \code{RunModel} call, as \code{$StateEnd} already respects the correct format; \cr
+   -  \code{IniStates} can be created with the \code{\link{CreateIniStates}} function.
+- remark 3:	in addition to \code{IniStates}, \code{IniResLevels} allows to set the filling rate of the production and routing stores for the GR models. For instance for GR4J and , GR5J: \code{IniResLevels <- c(0.3, 0.5)} should be used to obtain initial fillings of 30\% and 50\% for the production and routing stores, respectively. For GR6J, \code{IniResLevels <- c(0.3, 0.5, 0)} shold be use to obtain initial fillings of 30\% and 50\% for the production, routing stores and 0 mm for the exponential store, respectively. \code{IniResLevels} is optional and can only be used if \code{IniStates} is also defined (the state values corresponding to these two other stores in \code{IniStates} are not used in such case). \cr \cr
 }
 }
 \examples{