Commit 1816f53f authored by unknown's avatar unknown
Browse files

v0.1.2.34 airGRteaching.Rd file updated

parent 27c3205f
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.33
Version: 0.1.2.34
Date: 2017-04-10
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)
......
......@@ -233,7 +233,7 @@ $(document).ready(function () {
</div>
<div id="shiny-interface" class="section level3">
<h3><em>Shiny</em> interface</h3>
<p>The <strong><font color="#009EE0">airGRteaching</font></strong> package also provideq the <code>ShinyGR()</code> function, which allows to run the <em>Shiny</em> interface that is proposed on this website.</p>
<p>The <strong><font color="#009EE0">airGRteaching</font></strong> package also provides the <code>ShinyGR()</code> function, which allows to run the <em>Shiny</em> interface that is proposed on this website.</p>
<p>The <code>ShinyGR()</code> function just needs:</p>
<ul>
<li><code>ObsBV</code>: a name of a <code>data.frame</code> (or a <code>list</code> of names)</li>
......
......@@ -189,7 +189,7 @@ dyplot(SIM)
### *Shiny* interface
The <strong><font color="#009EE0">airGRteaching</font></strong> package also provideq the `ShinyGR()` function, which allows to run the *Shiny* interface that is proposed on this website.
The <strong><font color="#009EE0">airGRteaching</font></strong> package also provides the `ShinyGR()` function, which allows to run the *Shiny* interface that is proposed on this website.
The `ShinyGR()` function just needs:
......
......@@ -173,7 +173,7 @@ dyplot(SIM)
### *Shiny* interface
The `r airGRteaching` package also provideq the `ShinyGR()` function, which allows to run the *Shiny* interface that is proposed on this website.
The `r airGRteaching` package also provides the `ShinyGR()` function, which allows to run the *Shiny* interface that is proposed on this website.
The `ShinyGR()` function just needs:
......
......@@ -8,24 +8,41 @@
\description{
airGRteaching is an add-on package to the airGR package that simplifies its use and is teaching-oriented.
It allows to use with a very low-level programming the rainfall-runoff models (GR4H, GR4J, GR5J, GR6J, GR2M, GR1A) and a snowmelt module (CemaNeige). This package also provides graphical devices to help students to explore data and modelling results.
\cr
\cr\cr
# --- Functions and objects
# --- Modelling Functions
The airGRteaching package has been designed to fulfil two major requirements: facilitate the use by non-expert users and allow flexibility regarding the addition of external criteria, models or calibration algorithms. The names of the functions and their arguments were chosen to this end.
The airGRteaching package has been designed to fulfil two a major requirement: facilitate the use of the airGR functionalities by students. The names of the functions and their arguments were chosen to this end.
The package is mostly based on three families of functions: \cr
- the functions that allow to complete very simply a hydrological modelling exercise (\code{\link{ObsGR}()}: format data, calibration step: \code{\link{CalGR}()} and simulation step: \code{\link{SimGR}()}); \cr
- the functions that allow to complete very simply a hydrological modelling exercise (\code{\link{ObsGR}()}: preparatopn data, calibration step: \code{\link{CalGR}()} and simulation step: \code{\link{SimGR}()}); \cr
- plotting functions to help students to explore observed data and to interpret the results of calibration and simulation of the GR models (\code{\link{ObsGR}()}: format data, calibration step: \code{\link{CalGR}()} and simulation step: \code{\link{SimGR}()}); \cr
- a function which runs a shiny graphical interface that allows for displaying in real-time model parameters impacts on hydrographs (\code{\link{ShinyGR}()}).
\cr\cr
# --- Plotting Functions
airGRteaching provides two type of plotting functions which allows to produce static (\code{plot}()) or dynamic (\code{\link{dyplot}()}) graphics (mouse events and interactive graphics).
The devices allow to explore observed data and to interpret the results of calibration and simulation of the GR models.
\cr\cr
# --- Shiny interface
The package also provides the \code{\link{ShinyGR}()}) function, which allows to run a Shiny interface. Thus its is possible to run:
- interactive flow simulation with parameters modifications;
- automatic calibration;
- internal variables evolution,
- time period selection.
\cr\cr
# --- Models
Six hydrological models and one snow melt and accumulation module are implemented in airGRteaching. \cr
The six hydrological models and the snow melt and accumulation module available in airGR are implemented in airGRteaching. \cr
These models can be called within airGRteaching using the following functions: \cr
- \code{GR4H}: four-parameter hourly lumped hydrological model (Mathevet, 2005) \cr
- \code{GR4J}*: four-parameter daily lumped hydrological model (Perrin et al., 2003) \cr
......@@ -35,7 +52,7 @@ These models can be called within airGRteaching using the following functions: \
- \code{GR1A}: one-parameter yearly lumped hydrological model (Mouelhi, 2003 ; Mouelhi et al., 2006b) \cr
- \code{CemaNeige}: two-parameter degree-day snow melt and accumulation daily module (alone or combined with GR4J, GR5J or GR6J) (Valéry et al., 2014) \cr
* : availabe in the shiny interface.
\cr\cr
# --- References
......
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