Commit 3225317c authored by unknown's avatar unknown
Browse files

v0.1.2.39 airGRteaching.Rd file updated

parent 4371ab9c
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.38
Version: 0.1.2.39
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)
Imports: xts, dygraphs, shiny, plotrix, markdown
Imports: xts, dygraphs, shiny, plotrix
Description: Add-on package to the airGR package that simplifies its use and is teaching-oriented. The package provides three functions that allow to complete very simply a hydrological modelling exercise and plotting functions to help students to explore observed data and to interpret the results of calibration and simulation of the GR models. It includes a shiny graphical interface that allows for displaying in real-time model parameters impacts on hydrographs.
License: GPL-2
NeedsCompilation: no
URL: https://webgr.irstea.fr/airGR/?lang=en
URL: https://webgr.irstea.fr/airGR/
Encoding: UTF-8
......@@ -7,35 +7,38 @@
\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.
It allows to use with very low programming skills the rainfall-runoff models (GR4H, GR4J, GR5J, GR6J, GR2M, GR1A) and a snow melt and accumulation model (CemaNeige). This package also provides graphical devices to help students to explore data and modelling results.
\cr\cr
# --- Modelling Functions
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 airGRteaching package has been designed to fulfil a major requirement: facilitating 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}()}: 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}()}).
- the functions that allow to complete very simply a hydrological modelling exercise; \cr
- plotting functions to help students to explore observed data and to interpret the results of calibration and simulation of the GR models; \cr
- a function which runs a shiny graphical interface that allows for displaying in real-time model parameters impacts on hydrographs.
\cr\cr
# --- Modelling Functions
Three functions allow to complete very simply a hydrological modelling exercise:
- preparation of data: \code{\link{ObsGR}()}; \cr
- calibration of the models: \code{\link{CalGR}()}; \cr
- simulation with the models: \code{\link{SimGR}()}); \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).
airGRteaching provides two types of plotting functions that allow 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,
The package also provides the \code{\link{ShinyGR}()}) function, which allows to run a Shiny interface. Thus its is possible to run: \cr
- interactive flow simulation with parameters modifications; \cr
- automatic calibration; \cr
- internal variables evolution, \cr
- time period selection.
\cr\cr
......@@ -49,14 +52,15 @@ These models can be called within airGRteaching using the following functions: \
- \code{GR5J}*: five-parameter daily lumped hydrological model (Le Moine, 2008) \cr
- \code{GR6J}*: six-parameter daily lumped hydrological model (Pushpalatha et al., 2011) \cr
- \code{GR2M}: two-parameter monthly lumped hydrological model (Mouelhi, 2003 ; Mouelhi et al., 2006a) \cr
- \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.
- \code{GR1A}: one-parameter annual lumped hydrological model (Mouelhi, 2003 ; Mouelhi et al., 2006b) \cr
- \code{CemaNeige}: two-parameter degree-day snow melt and accumulation daily model (alone or combined with GR4J, GR5J or GR6J) (Valéry et al., 2014) \cr
*: available in the shiny interface.
\cr\cr
# --- References
- Coron, L., G. Thirel, O. Delaigue, C. Perrin and V. Andréassian (2017), The Suite of Lumped GR Hydrological Models in an R Package. Environmental Modelling and Software, 94, 166–171. doi: 10.1016/j.envsoft.2017.05.002. \cr
- Le Moine, N. (2008), Le bassin versant de surface vu par le souterrain : une voie d'amélioration des performances et du réalisme des modèles pluie-débit ?, PhD thesis (in French), UPMC - Cemagref Antony, Paris, France, 324 pp. \cr
- Mathevet, T. (2005), Quels modèles pluie-débit globaux pour le pas de temps horaire ? Développement empirique et comparaison de modèles sur un large échantillon de bassins versants, PhD thesis (in French), ENGREF - Cemagref Antony, Paris, France, 463 pp. \cr
- Mouelhi S. (2003), Vers une chaîne cohérente de modèles pluie-débit conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et journalier, PhD thesis (in French), ENGREF - Cemagref Antony, Paris, France, 323 pp. \cr
......@@ -64,7 +68,7 @@ These models can be called within airGRteaching using the following functions: \
- Mouelhi, S., C. Michel, C. Perrin. & V. Andreassian (2006b), Linking stream flow to rainfall at the annual time step: the Manabe bucket model revisited, Journal of Hydrology, 328, 283-296, doi:10.1016/j.jhydrol.2005.12.022. \cr
- Perrin, C., C. Michel and V. Andréassian (2003), Improvement of a parsimonious model for streamflow simulation, Journal of Hydrology, 279(1-4), 275-289, doi:10.1016/S0022-1694(03)00225-7. \cr
- Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011), A downward structural sensitivity analysis of hydrological models to improve low-flow simulation, Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014), "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine? Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, 517(0): 1176-1187, doi: 1176-1187, doi:10.1016/j.jhydrol.2014.04.058. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014), "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine? Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, 517(0): 1176-1187, doi:10.1016/j.jhydrol.2014.04.058. \cr
}
......
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