Commit 156a20c1 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

docs(man): format text, code embeded in the text and a bibliographical reference

parent 919dc477
Pipeline #26030 canceled with stages
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
\description{ \description{
Function which computes the function \code{ErrorCrit_GAPX}. Function which computes the function \code{ErrorCrit_GAPX}.
The produced function \code{ErrorCrit_GAPX} computes an error criterion based on the GAPX formula proposed by de Lavenne et al. (2019). The produced function \code{ErrorCrit_GAPX} computes an error criterion based on the GAPX formula proposed by Lavenne et al. (2019).
} }
...@@ -31,8 +31,8 @@ CreateErrorCrit_GAPX(FUN_TRANSFO) ...@@ -31,8 +31,8 @@ CreateErrorCrit_GAPX(FUN_TRANSFO)
\details{ \details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows 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 the use of the function for model calibration: the product \code{CritValue * Multiplier} is the criterion to be minimised
(Multiplier = -1 for NSE). (\codeMultiplier = -1} for NSE).
} }
\examples{ \examples{
...@@ -81,7 +81,9 @@ David Dorchies ...@@ -81,7 +81,9 @@ David Dorchies
} }
\references{ \references{
De Lavenne, A., Andréassian, V., Thirel, G., Ramos, M.-H., Perrin, C., 2019. A Regularization Approach to Improve the Sequential Calibration of a Semidistributed Hydrological Model. Water Resources Research 55, 8821–8839. \url{https://doi.org/10.1029/2018WR024266} de Lavenne, A., Andréassian, V., Thirel, G., Ramos, M.-H. and Perrin, C. (2019).
A Regularization Approach to Improve the Sequential Calibration of a Semidistributed Hydrological Model.
Water Resources Research 55, 8821–8839. \doi{10.1029/2018WR024266}
} }
\seealso{ \seealso{
......
...@@ -5,11 +5,11 @@ ...@@ -5,11 +5,11 @@
\alias{CreateInputsCrit_Lavenne} \alias{CreateInputsCrit_Lavenne}
\title{Creation of the InputsCrit object for De Lavenne Criterion} \title{Creation of the InputsCrit object for Lavenne Criterion}
\description{ \description{
Creation of the \code{InputsCrit} object required to the \code{\link{ErrorCrit}} function. This function defines a composed criterion based on the formula proposed by de Lavenne et al. (2019). Creation of the \code{InputsCrit} object required to the \code{\link{ErrorCrit}} function. This function defines a composed criterion based on the formula proposed by Lavenne et al. (2019).
} }
...@@ -57,9 +57,9 @@ CreateInputsCrit_Lavenne(FUN_CRIT = ErrorCrit_KGE, ...@@ -57,9 +57,9 @@ CreateInputsCrit_Lavenne(FUN_CRIT = ErrorCrit_KGE,
\code{CreateInputsCrit_Lavenne} returns an object of class \emph{Compo} that is a list of lists such as the one described in \code{\link{CreateInputsCrit}}. \code{CreateInputsCrit_Lavenne} returns an object of class \emph{Compo} that is a list of lists such as the one described in \code{\link{CreateInputsCrit}}.
Items \code{Weights} of the criteria are respectively equal to \code{k} and \code{k * max(0,AprCrit)}. Items \code{Weights} of the criteria are respectively equal to \code{k} and \code{k * max(0, AprCrit)}.
To calculate the De Lavenne criterion, it is necessary to use the \code{ErrorCrit} function as for any other composed criterion. To calculate the Lavenne criterion, it is necessary to use the \code{ErrorCrit} function as for any other composed criterion.
} }
...@@ -70,7 +70,7 @@ The parameters \code{FUN_CRIT}, \code{Obs}, \code{VarObs}, \code{BoolCrit}, \cod ...@@ -70,7 +70,7 @@ The parameters \code{FUN_CRIT}, \code{Obs}, \code{VarObs}, \code{BoolCrit}, \cod
\code{\link{ErrorCrit_RMSE}} cannot be used in a composite criterion since it is not a unitless value. \code{\link{ErrorCrit_RMSE}} cannot be used in a composite criterion since it is not a unitless value.
\code{CreateInputsCrit_Lavenne} creates a composed criterion in respect with Equations 1 and 2 of de Lavenne et al. (2019). \code{CreateInputsCrit_Lavenne} creates a composed criterion in respect with Equations 1 and 2 of Lavenne et al. (2019).
} }
...@@ -97,7 +97,7 @@ Param <- c(X1 = 257.238, X2 = 1.012, X3 = 88.235, X4 = 2.208) ...@@ -97,7 +97,7 @@ Param <- c(X1 = 257.238, X2 = 1.012, X3 = 88.235, X4 = 2.208)
OutputsModel <- RunModel_GR4J(InputsModel = InputsModel, OutputsModel <- RunModel_GR4J(InputsModel = InputsModel,
RunOptions = RunOptions, Param = Param) RunOptions = RunOptions, Param = Param)
## The "a priori" parameters for De Lavenne formula ## The "a priori" parameters for Lavenne formula
AprParamR <- c(X1 = 157, X2 = 0.8, X3 = 100, X4 = 1.5) AprParamR <- c(X1 = 157, X2 = 0.8, X3 = 100, X4 = 1.5)
## Single efficiency criterion: GAPX with a priori parameters ## Single efficiency criterion: GAPX with a priori parameters
...@@ -115,7 +115,9 @@ David Dorchies ...@@ -115,7 +115,9 @@ David Dorchies
\references{ \references{
De Lavenne, A., Andréassian, V., Thirel, G., Ramos, M.-H., Perrin, C., 2019. A Regularization Approach to Improve the Sequential Calibration of a Semidistributed Hydrological Model. Water Resources Research 55, 8821–8839. \url{https://doi.org/10.1029/2018WR024266} de Lavenne, A., Andréassian, V., Thirel, G., Ramos, M.-H. and Perrin, C. (2019).
A Regularization Approach to Improve the Sequential Calibration of a Semidistributed Hydrological Model.
Water Resources Research 55, 8821–8839. \doi{10.1029/2018WR024266}
} }
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment