diff --git a/DESCRIPTION b/DESCRIPTION
index bc9986b17736319b6ccf18be46dc70eb84f20a3b..3d70b482f2517315b7b0e24891e50f16180eacd7 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.4.3.58
+Version: 1.4.3.59
Date: 2020-01-28
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
diff --git a/NEWS.md b/NEWS.md
index 0e6446a60bcb06b542d86ad32246523567c0b5ae..431723a457fdc3a3d6af8d869a4c407187a77f83 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -2,7 +2,7 @@
-### 1.4.3.58 Release Notes (2020-01-28)
+### 1.4.3.59 Release Notes (2020-01-28)
#### Bug fixes
diff --git a/man/BasinInfo.Rd b/man/BasinInfo.Rd
index 54d9b93eb6fc0475615fb21b9faf9309f11f7a83..a3d6f8940b506a4c1684c890d0c989c4ef792a08 100644
--- a/man/BasinInfo.Rd
+++ b/man/BasinInfo.Rd
@@ -9,14 +9,6 @@
\title{Data sample: characteristics of a different catchments}
-\format{List named 'BasinInfo' containing
-\itemize{
-\item two strings: catchment's code and station's name
-\item one float: catchment's area in km2
-\item one numeric vector: catchment's hypsometric curve (min, quantiles 01 to 99 and max) in metres
-}}
-
-
\description{
L0123001, L0123002 and L0123003 are fictional catchments. \cr
X0310010 contains actual data from the Durance River at Embrun [La Clapière] (Hautes-Alpes, France). \cr
@@ -25,6 +17,14 @@ R-object containing the code, station's name, area and hypsometric curve of the
}
+\format{List named 'BasinInfo' containing
+\itemize{
+\item two strings: catchment's code and station's name
+\item one float: catchment's area in km2
+\item one numeric vector: catchment's hypsometric curve (min, quantiles 01 to 99 and max) in metres
+}}
+
+
\seealso{
\code{\link{BasinObs}}.
}
diff --git a/man/Calibration.Rd b/man/Calibration.Rd
index 75f62a30d2194b4d0eb4c5ebfd4e00ad5f7338bf..350d4ca032a6b275b5f9aa9220b7b4ae6fe7ca3e 100644
--- a/man/Calibration.Rd
+++ b/man/Calibration.Rd
@@ -7,10 +7,16 @@
\title{Calibration algorithm that optimises the error criterion selected as objective function using the provided functions}
+
+\description{
+Calibration algorithm that optimises the error criterion selected as objective function using the provided functions.
+}
+
+
\usage{
-Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
- FUN_CRIT, FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL,
- verbose = TRUE)
+Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions,
+ FUN_MOD, FUN_CRIT, FUN_CALIB = Calibration_Michel,
+ FUN_TRANSFO = NULL, verbose = TRUE)
}
@@ -40,11 +46,6 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
}
-\description{
-Calibration algorithm that optimises the error criterion selected as objective function using the provided functions.
-}
-
-
\examples{
library(airGR)
diff --git a/man/Calibration_Michel.Rd b/man/Calibration_Michel.Rd
index 50f6c7f554de9d6fb7ca98599f1258c89a9099d2..9c6aed87ef1e94b77a52acefd371cba787f3c9ab 100644
--- a/man/Calibration_Michel.Rd
+++ b/man/Calibration_Michel.Rd
@@ -8,9 +8,18 @@
\title{Calibration algorithm that optimises the error criterion selected as objective function using the Irstea procedure described by C. Michel}
+\description{
+Calibration algorithm that optimises the error criterion selected as objective function. \cr
+\cr
+The algorithm combines a global and a local approach.
+First, a screening is performed using either a rough predefined grid or a list of parameter sets.
+Then a steepest descent local search algorithm is performed, starting from the result of the screening procedure.
+}
+
+
\usage{
Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
- FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE)
+ FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE)
}
@@ -49,15 +58,6 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
}
-\description{
-Calibration algorithm that optimises the error criterion selected as objective function. \cr
-\cr
-The algorithm combines a global and a local approach.
-First, a screening is performed using either a rough predefined grid or a list of parameter sets.
-Then a steepest descent local search algorithm is performed, starting from the result of the screening procedure.
-}
-
-
\details{
A screening is first performed either based on a rough predefined grid (considering various initial
values for each parameter) or from a list of initial parameter sets. \cr
diff --git a/man/CreateCalibOptions.Rd b/man/CreateCalibOptions.Rd
index 6d99635b08cf5e49daf8bd7cfb0ebd231336a44f..451315191df00fdd1913485be25a5e3e49a1e4a1 100644
--- a/man/CreateCalibOptions.Rd
+++ b/man/CreateCalibOptions.Rd
@@ -8,11 +8,16 @@
\title{Creation of the CalibOptions object required but the Calibration functions}
+\description{
+Creation of the \emph{CalibOptions} object required by the \code{Calibration*} functions.
+}
+
+
\usage{
CreateCalibOptions(FUN_MOD, FUN_CALIB = Calibration_Michel,
- FUN_TRANSFO = NULL, IsHyst = FALSE, FixedParam = NULL,
- SearchRanges = NULL, StartParamList = NULL,
- StartParamDistrib = NULL)
+ FUN_TRANSFO = NULL, IsHyst = FALSE, FixedParam = NULL,
+ SearchRanges = NULL, StartParamList = NULL,
+ StartParamDistrib = NULL)
}
@@ -69,11 +74,6 @@ CreateCalibOptions(FUN_MOD, FUN_CALIB = Calibration_Michel,
}
-\description{
-Creation of the \emph{CalibOptions} object required by the \code{Calibration*} functions.
-}
-
-
\details{
Users wanting to use \code{FUN_MOD}, \code{FUN_CALIB} or \code{FUN_TRANSFO} functions that are not included in
the package must create their own \code{CalibOptions} object accordingly. \cr
diff --git a/man/CreateIniStates.Rd b/man/CreateIniStates.Rd
index e1ff5627e477be7e252125d0692b1d0bf0fa1d1c..5e2fed8357751f995973ab695373951c5a90d669 100644
--- a/man/CreateIniStates.Rd
+++ b/man/CreateIniStates.Rd
@@ -8,13 +8,18 @@
\title{Creation of the IniStates object possibly required by the CreateRunOptions functions}
+\description{
+Creation of the \emph{IniStates} object possibly required by the \code{\link{CreateRunOptions}} function.
+}
+
+
\usage{
CreateIniStates(FUN_MOD, InputsModel, IsHyst = FALSE, IsIntStore = FALSE,
- ProdStore = 350, RoutStore = 90, ExpStore = NULL, IntStore = NULL,
- UH1 = NULL, UH2 = NULL,
- GCemaNeigeLayers = NULL, eTGCemaNeigeLayers = NULL,
- GthrCemaNeigeLayers = NULL, GlocmaxCemaNeigeLayers = NULL,
- verbose = TRUE)
+ ProdStore = 350, RoutStore = 90, ExpStore = NULL, IntStore = NULL,
+ UH1 = NULL, UH2 = NULL,
+ GCemaNeigeLayers = NULL, eTGCemaNeigeLayers = NULL,
+ GthrCemaNeigeLayers = NULL, GlocmaxCemaNeigeLayers = NULL,
+ verbose = TRUE)
}
@@ -62,10 +67,6 @@ CreateIniStates(FUN_MOD, InputsModel, IsHyst = FALSE, IsIntStore = FALSE,
}
-\description{
-Creation of the \emph{IniStates} object possibly required by the \code{\link{CreateRunOptions}} function.
-}
-
\details{
20 numeric values are required for UH1 and 40 numeric values are required for UH2 if GR4J, GR5J or GR6J are used (respectively 20*24 and 40*24 for the hourly models GR4H and GR5H). Please note that depending on the X4 parameter value that will be provided when running the model, not all the values may be used (only the first int(X4)+1 values are used for UH1 and the first 2*int(X4)+1 for UH2). \cr
\code{GCemaNeigeLayers} and \code{eTGCemaNeigeLayers} require each numeric values as many as given in \code{\link{CreateInputsModel}} with the \code{NLayers} argument. \code{eTGCemaNeigeLayers} values can be negative.\cr
diff --git a/man/CreateInputsCrit.Rd b/man/CreateInputsCrit.Rd
index ffd70f7ac8db5136a71c0ae98c80b2c36c63f3b3..8e74569082bf7071658cd9d1cb05d89032b9b43a 100644
--- a/man/CreateInputsCrit.Rd
+++ b/man/CreateInputsCrit.Rd
@@ -8,12 +8,17 @@
\title{Creation of the InputsCrit object required to the ErrorCrit functions}
+\description{
+Creation of the \code{InputsCrit} object required to the \code{ErrorCrit_*} functions. This function is used to define whether the user wants to calculate a single criterion, multiple criteria in the same time, or a composite criterion, which averages several criteria.
+}
+
+
\usage{
CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions,
- Qobs, Obs, VarObs = "Q", BoolCrit = NULL,
- transfo = "", Weights = NULL,
- Ind_zeroes = NULL, epsilon = NULL,
- warnings = TRUE, verbose = TRUE)
+ Qobs, Obs, VarObs = "Q", BoolCrit = NULL,
+ transfo = "", Weights = NULL,
+ Ind_zeroes = NULL, epsilon = NULL,
+ warnings = TRUE, verbose = TRUE)
}
@@ -65,11 +70,6 @@ To calculate composite or multiple criteria, it is necessary to use the \code{Er
}
-\description{
-Creation of the \code{InputsCrit} object required to the \code{ErrorCrit_*} functions. This function is used to define whether the user wants to calculate a single criterion, multiple criteria in the same time, or a composite criterion, which averages several criteria.
-}
-
-
\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
diff --git a/man/CreateInputsModel.Rd b/man/CreateInputsModel.Rd
index e388126e1abb975ad0de9e7f970040943baaa53b..466d9d995d5357cc95a5a957e79db5d6c8b496ef 100644
--- a/man/CreateInputsModel.Rd
+++ b/man/CreateInputsModel.Rd
@@ -8,10 +8,15 @@
\title{Creation of the InputsModel object required to the RunModel functions}
+\description{
+Creation of the \emph{InputsModel} object required to the \code{RunModel*} functions.
+}
+
+
\usage{
CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
- TempMean = NULL, TempMin = NULL, TempMax = NULL, ZInputs = NULL, HypsoData = NULL,
- NLayers = 5, verbose = TRUE)
+ TempMean = NULL, TempMin = NULL, TempMax = NULL,
+ ZInputs = NULL, HypsoData = NULL, NLayers = 5, verbose = TRUE)
}
@@ -55,11 +60,6 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
}
-\description{
-Creation of the \emph{InputsModel} object required to the \code{RunModel*} functions.
-}
-
-
\details{
Users wanting to use \code{FUN_MOD} functions that are not included in
the package must create their own InputsModel object accordingly. \cr
diff --git a/man/CreateRunOptions.Rd b/man/CreateRunOptions.Rd
index 712c2aebd490808ab7b58a53a41cd732a5229208..eaa414c722ac889f9d703c122d70a864c865d3cb 100644
--- a/man/CreateRunOptions.Rd
+++ b/man/CreateRunOptions.Rd
@@ -8,14 +8,19 @@
\title{Creation of the RunOptions object required to the RunModel functions}
+\description{
+Creation of the RunOptions object required to the \code{RunModel*} functions.
+}
+
+
\usage{
CreateRunOptions(FUN_MOD, InputsModel,
- IndPeriod_WarmUp = NULL, IndPeriod_Run,
- IniStates = NULL, IniResLevels = NULL, Imax = NULL,
- Outputs_Cal = NULL, Outputs_Sim = "all",
- RunSnowModule, MeanAnSolidPrecip = NULL,
- IsHyst = FALSE,
- warnings = TRUE, verbose = TRUE)
+ IndPeriod_WarmUp = NULL, IndPeriod_Run,
+ IniStates = NULL, IniResLevels = NULL, Imax = NULL,
+ Outputs_Cal = NULL, Outputs_Sim = "all",
+ RunSnowModule, MeanAnSolidPrecip = NULL,
+ IsHyst = FALSE,
+ warnings = TRUE, verbose = TRUE)
}
@@ -68,11 +73,6 @@ CreateRunOptions(FUN_MOD, InputsModel,
}
-\description{
-Creation of the RunOptions object required to the \code{RunModel*} functions.
-}
-
-
\details{
Users wanting to use \code{FUN_MOD} functions that are not included in
the package must create their own \code{RunOptions} object accordingly.
diff --git a/man/DataAltiExtrapolation_Valery.Rd b/man/DataAltiExtrapolation_Valery.Rd
index 50e03123d93ee416062db66695c8838f99bb811a..b9c0da5776fb9bee1da37799624ff954465752d1 100644
--- a/man/DataAltiExtrapolation_Valery.Rd
+++ b/man/DataAltiExtrapolation_Valery.Rd
@@ -8,10 +8,15 @@
\title{Altitudinal extrapolation of precipitation and temperature series described by A. Valery}
+\description{
+Function which extrapolates the precipitation and air temperature series for different elevation layers (method from Valéry, 2010).
+}
+
+
\usage{
DataAltiExtrapolation_Valery(DatesR, Precip, PrecipScale = TRUE,
- TempMean, TempMin = NULL, TempMax = NULL,
- ZInputs, HypsoData, NLayers, verbose = TRUE)
+ TempMean, TempMin = NULL, TempMax = NULL,
+ ZInputs, HypsoData, NLayers, verbose = TRUE)
}
@@ -49,11 +54,6 @@ list containing the extrapolated series of precip. and air temp. on each elevati
}
-\description{
-Function which extrapolates the precipitation and air temperature series for different elevation layers (method from Valéry, 2010).
-}
-
-
\details{
Elevation layers of equal surface are created the 101 elevation quantiles (\code{HypsoData})
and the number requested elevation layers (\code{NLayers}). \cr
diff --git a/man/ErrorCrit.Rd b/man/ErrorCrit.Rd
index ec57c0e07d92cd9e1ada09120a12c5cea3905050..acb933c6b935ddb68b5ebdc23f6cbe7a736bf42c 100644
--- a/man/ErrorCrit.Rd
+++ b/man/ErrorCrit.Rd
@@ -8,6 +8,11 @@
\title{Error criterion using the provided function}
+\description{
+Function which computes an error criterion with the provided function.
+}
+
+
\usage{
ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, warnings = TRUE, verbose = TRUE)
}
@@ -26,10 +31,6 @@ ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, warnings = TRUE, verbose = TRUE)
}
-\description{
-Function which computes an error criterion with the provided function.
-}
-
\value{
If \code{InputsCrit} is of class \emph{Single}:
\tabular{ll}{
diff --git a/man/ErrorCrit_KGE.Rd b/man/ErrorCrit_KGE.Rd
index f5a1f10a5334ccdff863d6e6c5107f9674a33185..05beb6e1f088e349a0ee7d5f236fe48628af3e76 100644
--- a/man/ErrorCrit_KGE.Rd
+++ b/man/ErrorCrit_KGE.Rd
@@ -8,6 +8,11 @@
\title{Error criterion based on the KGE formula}
+\description{
+Function which computes an error criterion based on the KGE formula proposed by Gupta et al. (2009).
+}
+
+
\usage{
ErrorCrit_KGE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
@@ -38,11 +43,6 @@ ErrorCrit_KGE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
-\description{
-Function which computes an error criterion based on the KGE formula proposed by Gupta et al. (2009).
-}
-
-
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised (Multiplier = -1 for KGE).\cr\cr
diff --git a/man/ErrorCrit_KGE2.Rd b/man/ErrorCrit_KGE2.Rd
index c6de480cc15825963c0f77e2af17840f0fe11997..34571b287ed6cc1a0e05d7f52fb9a0577d944fef 100644
--- a/man/ErrorCrit_KGE2.Rd
+++ b/man/ErrorCrit_KGE2.Rd
@@ -8,6 +8,11 @@
\title{Error criterion based on the KGE' formula}
+\description{
+Function which computes an error criterion based on the KGE' formula proposed by Kling et al. (2012).
+}
+
+
\usage{
ErrorCrit_KGE2(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
@@ -38,11 +43,6 @@ ErrorCrit_KGE2(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
-\description{
-Function which computes an error criterion based on the KGE' formula proposed by Kling et al. (2012).
-}
-
-
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised (Multiplier = -1 for KGE2).\cr\cr
diff --git a/man/ErrorCrit_NSE.Rd b/man/ErrorCrit_NSE.Rd
index 67edc85dec5d64fb204b8b26c673956d706914b9..1ac5ea025b3ad2c0109fc14518efdc14fb03d7f5 100644
--- a/man/ErrorCrit_NSE.Rd
+++ b/man/ErrorCrit_NSE.Rd
@@ -13,6 +13,11 @@ ErrorCrit_NSE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
+\description{
+Function which computes an error criterion based on the NSE formula proposed by Nash & Sutcliffe (1970).
+}
+
+
\arguments{
\item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details}
@@ -36,11 +41,6 @@ ErrorCrit_NSE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
-\description{
-Function which computes an error criterion based on the NSE formula proposed by Nash & Sutcliffe (1970).
-}
-
-
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised
diff --git a/man/ErrorCrit_RMSE.Rd b/man/ErrorCrit_RMSE.Rd
index 699208e631673c8b797ab2d01aaaecf819c08505..89bc0223ff035a6b287f0b060c5dd4e3b3b9d331 100644
--- a/man/ErrorCrit_RMSE.Rd
+++ b/man/ErrorCrit_RMSE.Rd
@@ -3,6 +3,8 @@
\name{ErrorCrit_RMSE}
\alias{ErrorCrit_RMSE}
+
+
\title{Error criterion based on the RMSE}
@@ -11,6 +13,11 @@ ErrorCrit_RMSE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
+\description{
+Function which computes an error criterion based on the root-mean-square error (RMSE).
+}
+
+
\arguments{
\item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details}
@@ -34,11 +41,6 @@ ErrorCrit_RMSE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
}
-\description{
-Function which computes an error criterion based on the root-mean-square error (RMSE).
-}
-
-
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised
diff --git a/man/Imax.Rd b/man/Imax.Rd
index 4221ce564e052d9420849044b053600ff3952348..48f5e68f849dccaed124e3a0b5a7dd98764f2b06 100644
--- a/man/Imax.Rd
+++ b/man/Imax.Rd
@@ -8,6 +8,11 @@
\title{Computation of the maximum capacity of the GR5H interception store}
+\description{
+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.
+}
+
+
\usage{
Imax(InputsModel, IndPeriod_Run,
TestedValues = seq(from = 0.1, to = 3, by = 0.1))
@@ -28,11 +33,6 @@ Optimal Imax value [mm].
}
-\description{
-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.
-}
-
-
\examples{
library(airGR)
diff --git a/man/Param_Sets_GR4J.Rd b/man/Param_Sets_GR4J.Rd
index c2acf5e138bfa94de8931f959a012e3ec96c01a2..593664857e8f0e7f500ca3b62dd71653592ff2ea 100644
--- a/man/Param_Sets_GR4J.Rd
+++ b/man/Param_Sets_GR4J.Rd
@@ -9,6 +9,13 @@
\title{Generalist parameter sets for the GR4J model}
+\description{
+These parameter sets can be used as an alternative for the grid-screening calibration procedure (i.e. first step in \code{\link{Calibration_Michel}}).
+Please note that the given GR4J X4u variable does not correspond to the actual GR4J X4 parameter. As explained in Andréassian et al. (2014; section 2.1), the given GR4J X4u value has to be adjusted (rescaled) using catchment area (S) [km2] as follows: {X4 = X4u / 5.995 * S^0.3} (please note that the formula is erroneous in the publication). Please, see the example below. \cr
+As shown in Andréassian et al. (2014; figure 4), only using these parameters sets as the tested values for calibration is more efficient than a classical calibration when the amount of data is low (6 months or less).
+}
+
+
\format{Data frame of parameters containing four numeric vectors
\itemize{
\item {GR4J X1} {production store capacity [mm]}
@@ -18,13 +25,6 @@
}}
-\description{
-These parameter sets can be used as an alternative for the grid-screening calibration procedure (i.e. first step in \code{\link{Calibration_Michel}}).
-Please note that the given GR4J X4u variable does not correspond to the actual GR4J X4 parameter. As explained in Andréassian et al. (2014; section 2.1), the given GR4J X4u value has to be adjusted (rescaled) using catchment area (S) [km2] as follows: {X4 = X4u / 5.995 * S^0.3} (please note that the formula is erroneous in the publication). Please, see the example below. \cr
-As shown in Andréassian et al. (2014; figure 4), only using these parameters sets as the tested values for calibration is more efficient than a classical calibration when the amount of data is low (6 months or less).
-}
-
-
\seealso{
\code{\link{RunModel_GR4J}}, \code{\link{Calibration_Michel}}, \code{\link{CreateCalibOptions}}.
}
diff --git a/man/RunModel.Rd b/man/RunModel.Rd
index 7cb4b50193ff7fb5e97c33df4eb57d8c22e14047..473710d595e62e4ea64957d1f92ab95cad05bb17 100644
--- a/man/RunModel.Rd
+++ b/man/RunModel.Rd
@@ -3,9 +3,16 @@
\name{RunModel}
\alias{RunModel}
+
+
\title{Run with the provided hydrological model function}
+\description{
+Function which performs a single model run with the provided function over the selected period.
+}
+
+
\usage{
RunModel(InputsModel, RunOptions, Param, FUN_MOD)
}
@@ -27,11 +34,6 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD)
}
-\description{
-Function which performs a single model run with the provided function over the selected period.
-}
-
-
\examples{
library(airGR)
diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd
index f2ae1f040bfede8f59dde2b04ad02777f037166d..bdc6dcfc52f6fbfc92b921cfb41591def4a393df 100644
--- a/man/RunModel_CemaNeige.Rd
+++ b/man/RunModel_CemaNeige.Rd
@@ -8,6 +8,11 @@
\title{Run with the CemaNeige snow module}
+\description{
+Function which performs a single run for the CemaNeige snow module at the daily or hourly time step.
+}
+
+
\usage{
RunModel_CemaNeige(InputsModel, RunOptions, Param)
}
@@ -50,11 +55,6 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
}
-\description{
-Function which performs a single run for the CemaNeige snow module at the daily or hourly time step.
-}
-
-
\details{
The choice of the CemaNeige version (i.e. with or without hysteresis) is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
diff --git a/man/RunModel_CemaNeigeGR4H.Rd b/man/RunModel_CemaNeigeGR4H.Rd
index 1118c2a5487927747420761cb94d28506182117d..84789061435014966e98893569d28f7ee5a50a5e 100644
--- a/man/RunModel_CemaNeigeGR4H.Rd
+++ b/man/RunModel_CemaNeigeGR4H.Rd
@@ -8,6 +8,11 @@
\title{Run with the CemaNeigeGR4H hydrological model}
+\description{
+Function which performs a single run for the CemaNeige-GR4H hourly lumped model over the test period.
+}
+
+
\usage{
RunModel_CemaNeigeGR4H(InputsModel, RunOptions, Param)
}
@@ -72,11 +77,6 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
}
-\description{
-Function which performs a single run for the CemaNeige-GR4H hourly lumped model over the test period.
-}
-
-
\details{
It is advised to run the GR5H model with an interception store (see Ficchi et al. (2019)) as it improves the consistency of the model fluxes and provides better performance. To do so, the \code{\link{Imax}} functions allows to estimates the maximal capacity of the interception store, which can then be given to \code{\link{CreateRunOptions}}. \cr
diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd
index a0d6b396ae9f8c8508da53bf9ef9b507ea21b3ad..ef69110b869144fa742f79de1c441d8e4fb05128 100644
--- a/man/RunModel_CemaNeigeGR4J.Rd
+++ b/man/RunModel_CemaNeigeGR4J.Rd
@@ -8,6 +8,11 @@
\title{Run with the CemaNeigeGR4J hydrological model}
+\description{
+Function which performs a single run for the CemaNeige-GR4J daily lumped model over the test period.
+}
+
+
\usage{
RunModel_CemaNeigeGR4J(InputsModel, RunOptions, Param)
}
@@ -72,11 +77,6 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
}
-\description{
-Function which performs a single run for the CemaNeige-GR4J daily lumped model over the test period.
-}
-
-
\details{
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
diff --git a/man/RunModel_CemaNeigeGR5H.Rd b/man/RunModel_CemaNeigeGR5H.Rd
index 47017eff7db0178437e796b43ff3ddd228c38930..7f7f8585cfcb1713210b2048037339a945e08505 100644
--- a/man/RunModel_CemaNeigeGR5H.Rd
+++ b/man/RunModel_CemaNeigeGR5H.Rd
@@ -8,6 +8,11 @@
\title{Run with the CemaNeigeGR5H hydrological model}
+\description{
+Function which performs a single run for the CemaNeige-GR5H hourly lumped model over the test period.
+}
+
+
\usage{
RunModel_CemaNeigeGR5H(InputsModel, RunOptions, Param)
}
@@ -75,11 +80,6 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
}
-\description{
-Function which performs a single run for the CemaNeige-GR5H hourly lumped model over the test period.
-}
-
-
\details{
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd
index 8e78ab0637e55314552b1a3ed8cc07316d5ffc7c..d20d109b799cef2bd24a79a2a996ea0e29028788 100644
--- a/man/RunModel_CemaNeigeGR5J.Rd
+++ b/man/RunModel_CemaNeigeGR5J.Rd
@@ -8,6 +8,11 @@
\title{Run with the CemaNeigeGR5J hydrological model}
+\description{
+Function which performs a single run for the CemaNeige-GR5J daily lumped model.
+}
+
+
\usage{
RunModel_CemaNeigeGR5J(InputsModel, RunOptions, Param)
}
@@ -73,11 +78,6 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
}
-\description{
-Function which performs a single run for the CemaNeige-GR5J daily lumped model.
-}
-
-
\details{
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd
index b9c8a71d3399129f100de6cd62eb53a868857681..6a4120cfeeef38684e1d53eb99884d0366dad7a9 100644
--- a/man/RunModel_CemaNeigeGR6J.Rd
+++ b/man/RunModel_CemaNeigeGR6J.Rd
@@ -8,6 +8,11 @@
\title{Run with the CemaNeigeGR6J hydrological model}
+\description{
+Function which performs a single run for the CemaNeige-GR6J daily lumped model.
+}
+
+
\usage{
RunModel_CemaNeigeGR6J(InputsModel, RunOptions, Param)
}
@@ -76,11 +81,6 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
}
-\description{
-Function which performs a single run for the CemaNeige-GR6J daily lumped model.
-}
-
-
\details{
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
diff --git a/man/RunModel_GR1A.Rd b/man/RunModel_GR1A.Rd
index 8af5f475b0d7d801e7e04bb7e92c77d47483b8c8..dd9b2831a0dd1b2b281052a1f85353c99f888133 100644
--- a/man/RunModel_GR1A.Rd
+++ b/man/RunModel_GR1A.Rd
@@ -8,6 +8,11 @@
\title{Run with the GR1A hydrological model}
+\description{
+Function which performs a single run for the GR1A annual lumped model over the test period.
+}
+
+
\usage{
RunModel_GR1A(InputsModel, RunOptions, Param)
}
@@ -38,11 +43,6 @@ GR1A X1 \tab model parameter [-] \cr
}
-\description{
-Function which performs a single run for the GR1A annual lumped model over the test period.
-}
-
-
\details{
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
diff --git a/man/RunModel_GR2M.Rd b/man/RunModel_GR2M.Rd
index 7b933034bbab3c0263a9a63707bfe327b8c46f02..cea98d90c0ccef868436118f67c9f16672119d3d 100644
--- a/man/RunModel_GR2M.Rd
+++ b/man/RunModel_GR2M.Rd
@@ -8,6 +8,11 @@
\title{Run with the GR2M hydrological model}
+\description{
+Function which performs a single run for the GR2M monthly lumped model over the test period.
+}
+
+
\usage{
RunModel_GR2M(InputsModel, RunOptions, Param)
}
@@ -46,11 +51,6 @@ GR2M X2 \tab groundwater exchange coefficient [-] \cr
}
-\description{
-Function which performs a single run for the GR2M monthly lumped model over the test period.
-}
-
-
\details{
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd
index f16205c5bdf9d62b30dcb170a78e55dd71cc54a6..6321e5db65ebd27609f7000040b4083a9af9c98f 100644
--- a/man/RunModel_GR4H.Rd
+++ b/man/RunModel_GR4H.Rd
@@ -8,6 +8,11 @@
\title{Run with the GR4H hydrological model}
+\description{
+Function which performs a single run for the GR4H hourly lumped model.
+}
+
+
\usage{
RunModel_GR4H(InputsModel, RunOptions, Param)
}
@@ -56,11 +61,6 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
}
-\description{
-Function which performs a single run for the GR4H hourly lumped model.
-}
-
-
\details{
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
diff --git a/man/RunModel_GR4J.Rd b/man/RunModel_GR4J.Rd
index 441e69927a52cef726cf020f2ac632c596b63705..d03ff50f82920640c7dff30f9f6a36612ce9f1bd 100644
--- a/man/RunModel_GR4J.Rd
+++ b/man/RunModel_GR4J.Rd
@@ -8,6 +8,11 @@
\title{Run with the GR4J hydrological model}
+\description{
+Function which performs a single run for the GR4J daily lumped model over the test period.
+}
+
+
\usage{
RunModel_GR4J(InputsModel, RunOptions, Param)
}
@@ -56,11 +61,6 @@ RunModel_GR4J(InputsModel, RunOptions, Param)
}
-\description{
-Function which performs a single run for the GR4J daily lumped model over the test period.
-}
-
-
\details{
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
diff --git a/man/RunModel_GR5H.Rd b/man/RunModel_GR5H.Rd
index dd55413dcc3e17389145cd2ba2c6a77f0c1260b1..55420dc1131e4daeb66b5b66fb758d1d7ea60bd1 100644
--- a/man/RunModel_GR5H.Rd
+++ b/man/RunModel_GR5H.Rd
@@ -8,6 +8,11 @@
\title{Run with the GR5H hydrological model}
+\description{
+Function which performs a single run for the GR5H hourly lumped model.
+}
+
+
\usage{
RunModel_GR5H(InputsModel, RunOptions, Param)
}
@@ -60,11 +65,6 @@ RunModel_GR5H(InputsModel, RunOptions, Param)
}
-\description{
-Function which performs a single run for the GR5H hourly lumped model.
-}
-
-
\details{
It is advised to run the GR5H model with an interception store (see Ficchi (2017) and Ficchi et al. (2019)) as it improves the consistency of the model fluxes and provides better performance. To do so, the \code{\link{Imax}} function allows to estimate the maximal capacity of the interception store, which can then be given to \code{\link{CreateRunOptions}}. \cr
diff --git a/man/RunModel_GR5J.Rd b/man/RunModel_GR5J.Rd
index 5ad0333b7459a2aeb64a917d40c1c6ef6a4bc3ba..993dbf93439bcae897fc117c6099f8dbd92bc14a 100644
--- a/man/RunModel_GR5J.Rd
+++ b/man/RunModel_GR5J.Rd
@@ -8,6 +8,11 @@
\title{Run with the GR5J hydrological model}
+\description{
+Function which performs a single run for the GR5J daily lumped model over the test period.
+}
+
+
\usage{
RunModel_GR5J(InputsModel, RunOptions, Param)
}
@@ -57,11 +62,6 @@ RunModel_GR5J(InputsModel, RunOptions, Param)
}
-\description{
-Function which performs a single run for the GR5J daily lumped model over the test period.
-}
-
-
\details{
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
diff --git a/man/RunModel_GR6J.Rd b/man/RunModel_GR6J.Rd
index 1315c2ecba089f5d65a0f105031e7714e8fcb88d..9974afe991d986a02f31bcd632b13f311675f6a6 100644
--- a/man/RunModel_GR6J.Rd
+++ b/man/RunModel_GR6J.Rd
@@ -8,6 +8,11 @@
\title{Run with the GR6J hydrological model}
+\description{
+Function which performs a single run for the GR6J daily lumped model over the test period.
+}
+
+
\usage{
RunModel_GR6J(InputsModel, RunOptions, Param)
}
@@ -60,11 +65,6 @@ RunModel_GR6J(InputsModel, RunOptions, Param)
}
-\description{
-Function which performs a single run for the GR6J daily lumped model over the test period.
-}
-
-
\details{
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
diff --git a/man/SeriesAggreg.Rd b/man/SeriesAggreg.Rd
index 514bdf924177e0a08d65c3e96c59f67ec37a1839..4498eb6e09ef89614ef7561ff74e7e061e581363 100644
--- a/man/SeriesAggreg.Rd
+++ b/man/SeriesAggreg.Rd
@@ -8,9 +8,18 @@
\title{Conversion of time series to another time step (aggregation only)}
+\description{
+Conversion of time series to another time step (aggregation only). \cr
+Warning : on the aggregated outputs, the dates correspond to the beginning of the time step \cr
+(e.g. for daily time-series 2005-03-01 00:00 = value for period 2005-03-01 00:00 - 2005-03-01 23:59) \cr
+(e.g. for monthly time-series 2005-03-01 00:00 = value for period 2005-03-01 00:00 - 2005-03-31 23:59) \cr
+(e.g. for yearly time-series 2005-03-01 00:00 = value for period 2005-03-01 00:00 - 2006-02-28 23:59)
+}
+
+
\usage{
SeriesAggreg(TabSeries, TimeFormat, NewTimeFormat, ConvertFun,
- YearFirstMonth = 1, TimeLag = 0, verbose = TRUE)
+ YearFirstMonth = 1, TimeLag = 0, verbose = TRUE)
}
@@ -34,15 +43,6 @@ SeriesAggreg(TabSeries, TimeFormat, NewTimeFormat, ConvertFun,
}
-\description{
-Conversion of time series to another time step (aggregation only). \cr
-Warning : on the aggregated outputs, the dates correspond to the beginning of the time step \cr
-(e.g. for daily time-series 2005-03-01 00:00 = value for period 2005-03-01 00:00 - 2005-03-01 23:59) \cr
-(e.g. for monthly time-series 2005-03-01 00:00 = value for period 2005-03-01 00:00 - 2005-03-31 23:59) \cr
-(e.g. for yearly time-series 2005-03-01 00:00 = value for period 2005-03-01 00:00 - 2006-02-28 23:59)
-}
-
-
\examples{
library(airGR)
diff --git a/man/TransfoParam.Rd b/man/TransfoParam.Rd
index c04e1c1b62fd9ee475eb9ab8c0bb75e9637a20f6..0bf8485c4b1dda200e315fae53bcb1ec7977f278 100644
--- a/man/TransfoParam.Rd
+++ b/man/TransfoParam.Rd
@@ -17,6 +17,11 @@
\title{Transformation of the parameters using the provided function}
+\description{
+Function which transforms model parameters using the provided function (from raw to transformed parameters and vice versa).
+}
+
+
\usage{
## Generic function
TransfoParam(ParamIn, Direction, FUN_TRANSFO)
@@ -46,11 +51,6 @@ TransfoParam_CemaNeigeHyst(ParamIn, Direction)
}
-\description{
-Function which transforms model parameters using the provided function (from raw to transformed parameters and vice versa).
-}
-
-
\examples{
library(airGR)
diff --git a/man/plot.OutputsModel.Rd b/man/plot.OutputsModel.Rd
index 818e650aaa9415568ca1e5c5181f50afcc579a8a..f80ec0fd60dbdb4595557addd352db50504fa918 100644
--- a/man/plot.OutputsModel.Rd
+++ b/man/plot.OutputsModel.Rd
@@ -1,7 +1,7 @@
\encoding{UTF-8}
-\name{plot.OutputsModel}
+\name{plot}
\alias{plot.OutputsModel}
\alias{plot}
\alias{exampleSimPlot}
@@ -12,14 +12,19 @@
\title{Default preview of model outputs}
+\description{
+Function which creates a screen plot giving an overview of the model outputs.
+}
+
+
\usage{
\method{plot}{OutputsModel}(x, Qobs = NULL, IndPeriod_Plot = NULL,
- BasinArea = NULL, which = "synth", log_scale = FALSE,
- cex.axis = 1, cex.lab = 0.9, cex.leg = 0.9, lwd = 1,
- LayoutMat = NULL,
- LayoutWidths = rep.int(1, ncol(LayoutMat)),
- LayoutHeights = rep.int(1, nrow(LayoutMat)),
- verbose = TRUE, ...)
+ BasinArea = NULL, which = "synth", log_scale = FALSE,
+ cex.axis = 1, cex.lab = 0.9, cex.leg = 0.9, lwd = 1,
+ LayoutMat = NULL,
+ LayoutWidths = rep.int(1, ncol(LayoutMat)),
+ LayoutHeights = rep.int(1, nrow(LayoutMat)),
+ verbose = TRUE, ...)
}
@@ -61,11 +66,6 @@ Screen plot window.
}
-\description{
-Function which creates a screen plot giving an overview of the model outputs.
-}
-
-
\details{
Different types of independent graphs are available (depending on the model, but always drawn in this order):
\itemize{