Commit bf36d8ed authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

Merge branch '28-explicit-links-to-other-packages-in-documentation' into 'dev'

Resolve "Explicit links to other packages in documentation"

Closes #28

See merge request !10
parents 0733ab7e 7d3c21b7
Package: airGRteaching
Type: Package
Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included)
Version: 0.2.10.66
Date: 2020-10-20
Version: 0.2.10.72
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"),
person("Laurent", "Coron", role = c("aut"), comment = c(ORCID = "0000-0002-1503-6204")),
......
......@@ -4,7 +4,7 @@
### 0.2.10.66 Release Notes (2020-10-20)
### 0.2.10.72 Release Notes (2020-10-22)
#### Version control and issue tracking
......
......@@ -33,10 +33,10 @@ CalGR(PrepGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\value{
[list] object of class \code{CalGR} containing:
\item{OptionsCalib}{[list] object of class \code{RunOptions} (see: \code{\link{CreateRunOptions}})}
\item{OptionsCalib}{[list] object of class \code{RunOptions} (see: \code{\link[airGR]{CreateRunOptions}})}
\item{Qobs}{[numeric] series of observed discharges [mm/time step]}
\item{OutputsCalib}{[list] object of class \code{OutputsCalib} (see: \code{\link{Calibration}})}
\item{OutputsModel}{[list] object of class \code{OutputsModel} (see: \code{\link{RunModel}})}
\item{OutputsCalib}{[list] object of class \code{OutputsCalib} (see: \code{\link[airGR]{Calibration}})}
\item{OutputsModel}{[list] object of class \code{OutputsModel} (see: \code{\link[airGR]{RunModel}})}
\item{TypeModel}{[character] name of the function of the hydrological model used}
\item{CalCrit}{[character] name of the function that computes the error criterion during the calibration step}
\item{PeriodModel}{[list] \code{$WarmUp}: vector of 2 \code{POSIXct} values defining the beginning and end of the warm-up period, \code{$Run}: vector of 2 \code{POSIXct} values defining the beginning and end of the calibration period}
......@@ -44,7 +44,7 @@ CalGR(PrepGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\seealso{
\code{\link{CreateRunOptions}}, \code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}, \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}}, \code{\link{ErrorCrit_KGE}}, \code{\link{ErrorCrit_KGE2}}, \code{\link{Calibration_Michel}}
\code{\link[airGR]{CreateRunOptions}}, \code{\link[airGR]{CreateInputsCrit}}, \code{\link[airGR]{CreateCalibOptions}}, \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}, \code{\link[airGR]{ErrorCrit_KGE}}, \code{\link[airGR]{ErrorCrit_KGE2}}, \code{\link[airGR]{Calibration_Michel}}
}
......
......@@ -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.
}
......
......@@ -45,7 +45,7 @@ ShinyGR(ObsDF = NULL,
\seealso{
\code{\link{CalGR}, \link{SimGR}, \link{plot.CalGR}, \link{plot.SimGR}}
\code{\link{CalGR}, \link{SimGR}, \link[airGRteaching]{plot}}
}
......
......@@ -37,9 +37,9 @@ SimGR(PrepGR, CalGR = NULL, Param, EffCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\value{
[list] object of class \code{SimGR} containing:
\item{OptionsSimul}{[list] object of class \code{RunOptions} (see: \code{\link{CreateRunOptions}})}
\item{OptionsCrit}{[list] object of class \code{InputsCrit} (see: \code{\link{CreateInputsCrit}})}
\item{OutputsModel}{[list] object of class \code{OutputsModel} (see: \code{\link{RunModel}})}
\item{OptionsSimul}{[list] object of class \code{RunOptions} (see: \code{\link[airGR]{CreateRunOptions}})}
\item{OptionsCrit}{[list] object of class \code{InputsCrit} (see: \code{\link[airGR]{CreateInputsCrit}})}
\item{OutputsModel}{[list] object of class \code{OutputsModel} (see: \code{\link[airGR]{RunModel}})}
\item{Qobs}{[numeric] series of observed discharges [mm/time step]}
\item{TypeModel}{[character] name of the function of the hydrological model used}
\item{CalCrit}{[character] name of the function that computes the error criterion during the calibration step}
......@@ -50,7 +50,7 @@ SimGR(PrepGR, CalGR = NULL, Param, EffCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\seealso{
\code{\link{CreateRunOptions}}, \code{\link{CreateInputsCrit}}, \code{\link{RunModel}}, \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}}, \code{\link{ErrorCrit_KGE}}, \code{\link{ErrorCrit_KGE2}}
\code{\link[airGR]{CreateRunOptions}}, \code{\link[airGR]{CreateInputsCrit}}, \code{\link[airGR]{RunModel}}, \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}, \code{\link[airGR]{ErrorCrit_KGE}}, \code{\link[airGR]{ErrorCrit_KGE2}}
}
......
......@@ -27,11 +27,11 @@
\item{Qsup.name}{(optional) [character] a label for the legend of Qsup}
\item{col.Precip}{(optional) [character] vector of 1 (total precip.) or 2 (liquid and solid precip. with CemaNeige) color codes or names for precipitation (these can be of the form \code{"#AABBCC"} or \code{"rgb(255, 100, 200)"} or \code{"yellow"}), see \code{\link{par}} and \code{\link{rgb}}}
\item{col.Precip}{(optional) [character] vector of 1 (total precip.) or 2 (liquid and solid precip. with CemaNeige) color codes or names for precipitation (these can be of the form \code{"#AABBCC"} or \code{"rgb(255, 100, 200)"} or \code{"yellow"}), see \code{\link[graphics]{par}} and \code{\link[grDevices]{rgb}}}
\item{col.Q}{(optional) [character] vector of up to 3 color codes or names for observed (first value), simulated (second value, if provided) and additional (last value, if provided) flows, respectively (these can be of the form \code{"#AABBCC"} or \code{"rgb(255, 100, 200)"} or \code{"yellow"}), see \code{\link{par}} and \code{\link{rgb}}}
\item{col.Q}{(optional) [character] vector of up to 3 color codes or names for observed (first value), simulated (second value, if provided) and additional (last value, if provided) flows, respectively (these can be of the form \code{"#AABBCC"} or \code{"rgb(255, 100, 200)"} or \code{"yellow"}), see \code{\link[graphics]{par}} and \code{\link[grDevices]{rgb}}}
\item{col.na}{(optional) [character] color code or name for missing values(these can be of the form \code{"#AABBCC"} or \code{"rgb(255, 100, 200)"} or \code{"yellow"}), see \code{\link{par}} and \code{\link{rgb}}}
\item{col.na}{(optional) [character] color code or name for missing values(these can be of the form \code{"#AABBCC"} or \code{"rgb(255, 100, 200)"} or \code{"yellow"}), see \code{\link[graphics]{par}} and \code{\link[grDevices]{rgb}}}
\item{ylab}{(optional) [character] a label for the y-axis (flow and precipitation)}
......@@ -39,11 +39,11 @@
\item{plot.na}{[boolean] indicating if the missing values are plotted on the x-axis}
\item{RangeSelector}{(optional) [boolean] add a range selector to the bottom of the chart that allows users to pan and zoom to various date ranges (see \code{\link{dyRangeSelector}})}
\item{RangeSelector}{(optional) [boolean] add a range selector to the bottom of the chart that allows users to pan and zoom to various date ranges (see \code{\link[dygraphs]{dyRangeSelector}})}
\item{Roller}{(optional) [numeric] number of time scale units (e.g. days, months, years) to average values over (see \code{\link{dyRoller}})}
\item{Roller}{(optional) [numeric] number of time scale units (e.g. days, months, years) to average values over (see \code{\link[dygraphs]{dyRoller}})}
\item{LegendShow}{(optional) [character] when to display the legend. Specify \code{"always"} to always show the legend. Specify \code{"onmouseover"} to only display it when a user mouses over the chart. Specify \code{"follow"} (default) to have the legend show as overlay to the chart which follows the mouse. See \code{\link{dyLegend}}}
\item{LegendShow}{(optional) [character] when to display the legend. Specify \code{"always"} to always show the legend. Specify \code{"onmouseover"} to only display it when a user mouses over the chart. Specify \code{"follow"} (default) to have the legend show as overlay to the chart which follows the mouse. See \code{\link[dygraphs]{dyLegend}}}
\item{...}{other parameters to be passed through to plotting functions}
}
......
......@@ -29,19 +29,19 @@
\arguments{
\item{x}{[object of class \emph{PrepGR}] see \code{\link{PrepGR}} for details}
\item{type}{[character] the type of plot that should be drawn (see \code{\link{plot}} for details)}
\item{type}{[character] the type of plot that should be drawn (see \code{\link[base]{plot}} for details)}
\item{col.Precip}{(optional) [character]color code or name for precipitation, see \code{\link{par}}}
\item{col.Precip}{(optional) [character]color code or name for precipitation, see \code{\link[graphics]{par}}}
\item{col.Q}{(optional) [character] color code or name for observed flow, see \code{\link{par}}}
\item{col.Q}{(optional) [character] color code or name for observed flow, see \code{\link[graphics]{par}}}
\item{col.na}{(optional) [character] color code or name for missing values, see \code{\link{par}}}
\item{col.na}{(optional) [character] color code or name for missing values, see \code{\link[graphics]{par}}}
\item{xlab}{(optional) [character] a label for the x-axis (see \code{\link{title}})}
\item{xlab}{(optional) [character] a label for the x-axis (see \code{\link[graphics]{title}})}
\item{ylab}{(optional) [character] a label for the y-axis (vector of 1 or 2 values for rainfall and flow respectively; see \code{\link{title}})}
\item{ylab}{(optional) [character] a label for the y-axis (vector of 1 or 2 values for rainfall and flow respectively; see \code{\link[graphics]{title}})}
\item{main}{(optional) [character] a main title for the plot (see \code{\link{title}})}
\item{main}{(optional) [character] a main title for the plot (see \code{\link[graphics]{title}})}
\item{plot.na}{[boolean] boolean indicating if the missing values are plotted on the x-axis}
......
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