From b0dd9cc7e5f0dac9d95d7b57e9af6559255b8f00 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Tue, 12 Jan 2021 15:08:28 +0100
Subject: [PATCH] v1.6.9.17 docs(man): add text and hyperlink in
Runmodel_CemaNeige* and Runmodel_GR4H to inform users about the presence of
hydrological model diagrams
---
DESCRIPTION | 2 +-
NEWS.md | 2 +-
man/RunModel_CemaNeigeGR4H.Rd | 3 +++
man/RunModel_CemaNeigeGR4J.Rd | 3 +++
man/RunModel_CemaNeigeGR5H.Rd | 3 +++
man/RunModel_CemaNeigeGR5J.Rd | 3 +++
man/RunModel_CemaNeigeGR6J.Rd | 3 +++
man/RunModel_GR4H.Rd | 23 +++++++++++++----------
8 files changed, 30 insertions(+), 12 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 0c74a543..970f30f8 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.6.9.16
+Version: 1.6.9.17
Date: 2021-01-12
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 19821232..208096a1 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -2,7 +2,7 @@
-### 1.6.9.16 Release Notes (2021-01-12)
+### 1.6.9.17 Release Notes (2021-01-12)
#### New features
diff --git a/man/RunModel_CemaNeigeGR4H.Rd b/man/RunModel_CemaNeigeGR4H.Rd
index 223e31e9..e95db8f6 100644
--- a/man/RunModel_CemaNeigeGR4H.Rd
+++ b/man/RunModel_CemaNeigeGR4H.Rd
@@ -83,6 +83,9 @@ It is advised to run the GR5H model with an interception store (see Ficchi et al
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
+\cr
+\cr
+See \code{\link{RunModel_GR4J}} to look at the diagram of the hydrological model.
}
diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd
index 9faef809..27e32588 100644
--- a/man/RunModel_CemaNeigeGR4J.Rd
+++ b/man/RunModel_CemaNeigeGR4J.Rd
@@ -81,6 +81,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
+\cr
+\cr
+See \code{\link{RunModel_GR4J}} to look at the diagram of the hydrological model.
}
diff --git a/man/RunModel_CemaNeigeGR5H.Rd b/man/RunModel_CemaNeigeGR5H.Rd
index c17cab74..5500f132 100644
--- a/man/RunModel_CemaNeigeGR5H.Rd
+++ b/man/RunModel_CemaNeigeGR5H.Rd
@@ -84,6 +84,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
+\cr
+\cr
+See \code{\link{RunModel_GR5H}} to look at the diagram of the hydrological model.
}
diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd
index 932a2784..fa3b5bfb 100644
--- a/man/RunModel_CemaNeigeGR5J.Rd
+++ b/man/RunModel_CemaNeigeGR5J.Rd
@@ -82,6 +82,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
+\cr
+\cr
+See \code{\link{RunModel_GR5J}} to look at the diagram of the hydrological model.
}
diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd
index bfada27b..7480ecf9 100644
--- a/man/RunModel_CemaNeigeGR6J.Rd
+++ b/man/RunModel_CemaNeigeGR6J.Rd
@@ -85,6 +85,9 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
+\cr
+\cr
+See \code{\link{RunModel_GR6J}} to look at the diagram of the hydrological model.
}
diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd
index f763792e..f76d9a3d 100644
--- a/man/RunModel_GR4H.Rd
+++ b/man/RunModel_GR4H.Rd
@@ -24,7 +24,7 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
- \tabular{ll}{
+ \tabular{ll}{
GR4H X1 \tab production store capacity [mm] \cr
GR4H X2 \tab groundwater exchange coefficient [mm/h] \cr
GR4H X3 \tab routing store capacity [mm] \cr
@@ -34,8 +34,8 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/h] \cr
@@ -56,14 +56,17 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], see \code{\link{CreateIniStates}} for more details \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\details{
-For further details on the model, see the references section.
+For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
+\cr
+\cr
+See \code{\link{RunModel_GR4J}} to look at the diagram of the hydrological model.
}
@@ -105,13 +108,13 @@ Laurent Coron, Charles Perrin, Thibaut Mathevet, Olivier Delaigue, Guillaume Thi
\references{
-Mathevet, T. (2005).
- Quels modèles pluie-débit globaux pour le pas de temps horaire ?
- Développement empirique et comparaison de modèles sur un large échantillon de bassins versants.
+Mathevet, T. (2005).
+ Quels modèles pluie-débit globaux pour le pas de temps horaire ?
+ Développement empirique et comparaison de modèles sur un large échantillon de bassins versants.
PhD thesis (in French), ENGREF - Cemagref Antony, Paris, France.
\cr\cr
-Le Moine, N. (2008).
- Le bassin versant de surface vu par le souterrain :
+Le Moine, N. (2008).
+ Le bassin versant de surface vu par le souterrain :
une voie d'amélioration des performances et du réalisme des modèles pluie-débit ?
PhD thesis (in French), UPMC - Cemagref Antony, Paris, France.
}
--
GitLab