Commit 867c0259 authored by unknown's avatar unknown
Browse files

v0.1.2.50 several Rd file updated #4598

parent e2881ad4
Package: airGRteaching
Type: Package
Title: Tools to Simplify the Use of the airGR Hydrological Package for Education (Including a Shiny Application)
Version: 0.1.2.49
Version: 0.1.2.50
Date: 2017-06-01
Authors@R: c(person("Olivier", "Delaigue", role = c("aut", "cre"), email = "airGR@irstea.fr"), person("Laurent", "Coron", role = c("aut")), person("Pierre", "Brigode", role = c("aut")), person("Guillaume", "Thirel", role = c("ctb")))
Depends: airGR (>= 1.0.5.22)
......
......@@ -14,7 +14,7 @@ CalGR(ObsGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\arguments{
\item{ObsGR}{[object of class \code{ObsGR}] see \code{\link{ObsGR}} for details}
\item{CalCrit}{[character] name of the objective function (must be one of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"}, \code{"RMSE"})}
\item{CalCrit}{[character] name of the objective function (must be one of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"} or \code{"RMSE"})}
\item{WupPer}{(optional) [character] vector of 2 values to define the warm-up period [\code{"YYYY-mm-dd"} or \code{"YYYY-mm-dd HH:MM:SS"}]}
......
......@@ -31,7 +31,7 @@ ObsGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
\item{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create CemaNeige model inputs}
\item{TypeModel}{[character] name of the hydrological model (must be one of \code{"GR1A"}, \code{"GR2M"}, \code{"GR4J"}, \code{"GR5J"}, \code{"GR6J"}, \code{"GR4H"})}
\item{TypeModel}{[character] name of the hydrological model (must be one of \code{"GR1A"}, \code{"GR2M"}, \code{"GR4J"}, \code{"GR5J"}, \code{"GR6J"} or \code{"GR4H"})}
\item{CemaNeige}{[boolean] option indicating whether CemaNeige should be activated (only available when \code{TypeModel} is equal to any of \code{"GR4J"}, \code{"GR5J"} or \code{"GR6J"})}
}
......
......@@ -18,7 +18,7 @@ SimGR(ObsGR, CalGR = NULL, Param = NULL, EffCrit = c("NSE", "KGE", "KGE2", "RMSE
\item{Param}{(optional) [numeric] vector of parameters (the number depends on the model used)}
\item{EffCrit}{[character] name of the efficiency criterion (must be one of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"}, \code{"RMSE"})}
\item{EffCrit}{[character] name of the efficiency criterion (must be one of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"} or \code{"RMSE"})}
\item{WupPer}{(optional) [character] vector of 2 values to define the warm-up period [\code{"YYYY-mm-dd"} or \code{"YYYY-mm-dd HH:MM:SS"}]}
......@@ -39,7 +39,7 @@ SimGR(ObsGR, CalGR = NULL, Param = NULL, EffCrit = c("NSE", "KGE", "KGE2", "RMSE
\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{EffCrit}{[list] name of the function that computes the error criterion during the simulation step}
\item{PeriodModel}{[list] \code{$WarmUp}: vector of 2 \code{POSIXct} values defining the warm-up period, \code{$Run}: vector of 2 \code{POSIXct} values defining the calibration period}
\item{PeriodModel}{[list] \code{$WarmUp}: vector of 2 \code{POSIXct} values defining the warm-up period; \code{$Run}: vector of 2 \code{POSIXct} values defining the calibration period}
}
......
......@@ -24,7 +24,7 @@ The package is mostly based on three families of functions: \cr
Three functions allow to complete very simply a hydrological modelling exercise: \cr
- preparation of data: \code{\link{ObsGR}()}; \cr
- calibration of the models: \code{\link{CalGR}()}; \cr
- simulation with the models: \code{\link{SimGR}()}); \cr
- simulation with the models: \code{\link{SimGR}()}
\cr\cr
......
......@@ -12,9 +12,9 @@
\arguments{
\item{x}{[object of class \emph{CalGR}] see \code{\link{CalGR}} for details}
\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{title}})}
\item{ylab}{(optional) [character] a label for the y-axis (flow and precipitation) (see \code{\link{title}})}
\item{ylab}{(optional) [character] a label for the y-axis (flow and precipitation; see \code{\link{title}})}
\item{main}{(optional) [character] a main title for the plot (see \code{\link{title}})}
......
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