Commit de20130c authored by unknown's avatar unknown
Browse files

v0.1.11.16 revision of functionalities tabPanel in ShinyGR

parent c29bda9e
Package: airGRteaching
Type: Package
Title: Tools to Simplify the Use of the airGR Hydrological Package for Education (Including a Shiny Interface)
Version: 0.1.11.15
Version: 0.1.11.16
Date: 2018-01-31
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.9.43)
......
......@@ -67,7 +67,7 @@ For this step, you just have to use the `PrepGR()` function. You have to define:
If you want to use CemaNeige, you also have to define:
* catchment average air temperature in your data
* catchment average air temperature in `ObsDF` or in `TempMean`
* `HypsoData`: a vector of 101 reals: min, quantiles (1 % to 99 %) and max of catchment elevation distribution [m]; if not defined a single elevation layer is used for CemaNeige
* `NLayers`: the number of elevation layers requested [-]
......@@ -101,7 +101,7 @@ CAL <- CalGR(PrepGR = PREP, CalCrit = "KGE2",
#### Simulation step
The `PrepGR` and `WupPer` arguments are similar to the ones of the `CalGR()` function. Here, `EffCrit` is used to calculate the performance of the model over the simulation period `SimPer` and `CalGR` is the object returned by the `CalGR()` function.
To run a model, please use the `SimGR()` function. The `PrepGR` and `WupPer` arguments of `SimGR()` are similar to the ones of the `CalGR()` function. Here, `EffCrit` is used to calculate the performance of the model over the simulation period `SimPer` and `CalGR` is the object returned by the `CalGR()` function.
```{r, warning=FALSE}
SIM <- SimGR(PrepGR = PREP, CalGR = CAL, EffCrit = "KGE2",
......@@ -114,7 +114,7 @@ SIM <- SimGR(PrepGR = PREP, CalGR = CAL, EffCrit = "KGE2",
#### Static plots
The call of the `plot()` function with an `PrepGR` object draws the observed precipitation and discharge time series.
The call of the `plot()` function with a `PrepGR` object draws the observed precipitation and discharge time series.
```{r, echo=-1}
par(cex.lab = 0.6, cex.axis = 0.6)
......@@ -176,21 +176,12 @@ The `r airGRteaching` package also provides the `ShinyGR()` function, which allo
The `ShinyGR()` function just needs:
* `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:
* `PrepGR`: the object returned by the `PrepGR()` function
* `CalPer`: a vector of 2 dates to define the calibration period
* `ObsDF`: a `data.frame` (or a `list` of `data.frame`)
* `SimPer`: a vector (or list of vectors) of 2 dates to define the simulation period(s)
You can obviously define another objective function or warm-up period:
* `WupPer`: a vector of 2 dates to define the warm-up period
```{r, eval=FALSE}
ShinyGR(ObsDF = "BasinObs", SimPer = c("1994-01-01", "1998-12-31"))
ShinyGR(ObsDF = BasinObs, SimPer = c("1994-01-01", "1998-12-31"))
```
Only daily models are currently available (GR4J, GR5J, GR6J + CemaNeige).
......
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