Commit 3aaeaaa8 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v0.2.10.68 docs(PrepGR): explicit links to airGR funcions

Refs #28
parent 5faf591c
Package: airGRteaching
Type: Package
Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included)
Version: 0.2.10.67
Version: 0.2.10.68
Date: 2020-10-22
Authors@R: c(
person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),
......
......@@ -4,7 +4,7 @@
### 0.2.10.67 Release Notes (2020-10-22)
### 0.2.10.68 Release Notes (2020-10-22)
#### Version control and issue tracking
......
......@@ -44,21 +44,21 @@ PrepGR(ObsDF = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
\value{
[list] object of class \code{PrepGR} containing the data required to evaluate the model outputs:
\item{InputsModel}{[list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs (see: \code{\link{CreateInputsModel}} outputs)}
\item{InputsModel}{[list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs (see: \code{\link[airGR]{CreateInputsModel}} outputs)}
\item{Qobs}{[numeric] time series of observed discharges [mm/time step]}
\item{HydroModel}{[character] name of the function of the hydrological model used}
}
\seealso{
\code{\link{CreateInputsModel}}
\code{\link[airGR]{CreateInputsModel}}
}
\details{
If the \code{ObsDF} argument is provided, \code{DatesR}, \code{Precip}, \code{PotEvap}, \code{Qobs} and \code{TempMean} are not necessary, and vice-versa. If one variable is provided in \code{ObsDF} and also separately, then only the data included in \code{ObsDF} are used.
\cr \cr
If the \code{CemaNeige} argument is set to \code{TRUE}, the default version of CemaNeige is used (i.e. without the Linear Hysteresis, see the details part in \code{\link{CreateRunOptions}}).
If the \code{CemaNeige} argument is set to \code{TRUE}, the default version of CemaNeige is used (i.e. without the Linear Hysteresis, see the details part in \code{\link[airGR]{CreateRunOptions}}).
\cr\cr
The \code{PrepGR} function can be used even if no observed discharges are available. In this case, it is necessary to provide observed discharges time series equal to NA: this means that either the \code{ObsDF} observed discharges column or the \code{Qobs} arguments, depending on the format of data you provide, must be provided and filled with NAs.
}
......
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