@@ -176,7 +176,7 @@ The `r airGRteaching` package also provides the `ShinyGR()` function, which allo
The `ShinyGR()` function just needs:
* `ObsBV`: a name of a `data.frame` (or a `list` of names)
* `ObsDF`: a name of a `data.frame` (or a `list` of names)
* `SimPer`: a vector of 2 dates to define the simulation period
By default, the objective function used is the Kling-Gupta criterion (KGE), and the warm-up period is automatically set (depending on model). You have to define:
...
...
@@ -190,7 +190,7 @@ You can obviously define another objective function or warm-up period:
* `WupPer`: a vector of 2 dates to define the warm-up period
\item{ObsBV}{(optional) [data.frame] data.frame of dates, total precipitation, potential evapotranspiration, observed discharges and mean air temperature (only if CemaNeige is used) (variables must be in this order; see below for the units)}
\item{ObsDF}{(optional) [data.frame] data.frame of dates, total precipitation, potential evapotranspiration, observed discharges and mean air temperature (only if CemaNeige is used) (variables must be in this order; see below for the units)}
\item{DatesR}{(optional) [POSIXt] vector of dates required to create the GR and CemaNeige (if used) models inputs. Time zone must be defined as "UTC"}
\description{Creation of the inputs required to run the CalGR and SimGR functions}
\details{
If the \code{ObsBV} 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{ObsBV} and also separately, then only the data included in \code{ObsBV} are used.
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.
\item{ObsBV}{(optional) [data.frame or list of data.frame] \code{data.frame}1 of dates, total precipitation, evapotranspiration, observed discharges and mean air temperature (only if CemaNeige is used) (variables must be in this order; see below for the units)}
\item{ObsDF}{(optional) [data.frame or list of data.frame] \code{data.frame}1 of dates, total precipitation, evapotranspiration, observed discharges and mean air temperature (only if CemaNeige is used) (variables must be in this order; see below for the units)}
\item{DatesR}{(optional) [POSIXt] vector of dates required to create the GR and CemaNeige models inputs. Time zone must be defined as "UTC"}
...
...
@@ -33,7 +33,7 @@ ShinyGR(ObsBV = NULL,
\item{SimPer}{[character or list of characters] vector of 2 values to define the simulation period [\code{"YYYY-mm-dd"} or \code{"YYYY-mm-dd HH:MM:SS"}], see below for details}
\item{NamesObsBV}{(optional) [character] vector of values to define the data inputs name(s) (if the ObsBV list is not already named)}
\item{NamesObsBV}{(optional) [character] vector of values to define the data inputs name(s) (if the ObsDF list is not already named)}
\item{theme}{(optional) [character] alternative stylesheet [\code{"RStudio"} (default), \code{"Cerulean"}, \code{"Cyborg"}, \code{"Flatly"}, \code{"United"} or \code{"Yeti"}]}
}
...
...
@@ -47,7 +47,7 @@ ShinyGR(ObsBV = NULL,
\description{Shiny application to understand the impact of each parameter of the GR models on the simulated flows}
\details{
If the \code{ObsBV} contains a list of several character names of datasets, the simulation period (defined in \code{SimPer}) will be applied on all datasets. As a consequence it is necessary to check that the periods are common to the different datasets. The warm-up period always starts from the first date to the step time just before the start of the simulation period.
If the \code{ObsDF} contains a list of several character names of datasets, the simulation period (defined in \code{SimPer}) will be applied on all datasets. As a consequence it is necessary to check that the periods are common to the different datasets. The warm-up period always starts from the first date to the step time just before the start of the simulation period.
}
\author{
...
...
@@ -70,7 +70,7 @@ BI_L0123002 <- BasinInfo
## Interactive simulation step using default parameters