License License GPL 2 GPL 2

1 What is the airGRteaching package?

1.1 Presentation

airGRteaching logo

airGRteaching is an add-on package to the airGR package. It simplifies its use and is more specifically oriented towards teaching than airGR. It provides access to the GR rainfall-runoff models (GR4H, GR5H, GR4J, GR5J, GR6J, GR2M, GR1A) and a snow melt and accumulation model (CemaNeige) with limited programming skills. This package also provides a graphical interface to help students exploring data and model results.

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.

1.2 Main features of airGRteaching

The package is mostly based on three new families of functions:

  • the functions that allow to complete very simply a hydrological modelling exercise
  • plotting functions to help students to explore observed data and to interpret the results of calibration and simulation of the GR models
  • a function which runs a ‘Shiny’ graphical interface that allows for displaying in real-time model parameters impacts on hydrographs

2 Installation

You can install the package with the following command:

install.packages("airGRteaching")

If you use RStudio, you can use the Packages interface :

All the dependencie will ba automatically download and installed with airGRteaching:

  • airGR
  • dygraphs
  • markdown
  • plotrix
  • shiny
  • shinyjs
  • xts

You cannot run airGRteaching without airGR. You cannot perform dynamic graphics to visualize your inputs or your results time-series whithout the xts and the dygraphs packages, but you can produce static charts. All the other packages are needed to run the Shiny GUI.

You can download the airGRteaching source, Windows binaries or macOS binaries on the CRAN.

3 Misc

3.1 How to cite the package

To cite the airGRteaching package in your scientific document, please use the references returned by the citation() function:

citation("airGRteaching")
To cite airGRteaching in publications use these two references:

  Delaigue, O., Brigode, P., Thirel, G. and Coron, L. (2023). airGRteaching: an open-source tool
  for teaching hydrological modeling with R. Hydrology and Earth System Sciences 27, 3293–3327,
  doi: 10.5194/hess-27-3293-2023.

  Delaigue, O., Coron, L., Brigode, P. and Thirel, G. (2024). airGRteaching: Teaching Hydrological
  Modelling with GR (Shiny Interface Included). R package version 0.3.3, doi:
  10.32614/CRAN.package.airGRteaching.

To see these entries in BibTeX format, use 'print(<citation>, bibtex=TRUE)', 'toBibtex(.)', or set
'options(citation.bibtex.max=999)'.

To retrieve a “.bib” format for LaTeX documents, you can use the following command:

toBibtex(citation("airGRteaching"))
@Article{,
  author = {O. Delaigue and P. Brigode and G. Thirel and L. Coron},
  title = {{airGRteaching}: an open-source tool for teaching hydrological modeling with {R}},
  booktitle = {HIC 2018. 13th International Conference on Hydroinformatics},
  journal = {Hydrology and Earth System Sciences},
  volume = {27},
  number = {17},
  pages = {3293-3327},
  year = {2023},
  url = {https://hess.copernicus.org/articles/27/3293/2023/},
  doi = {10.5194/hess-27-3293-2023},
}

@Manual{,
  title = {{airGRteaching}: Teaching Hydrological Modelling with {GR} ({Shiny} Interface Included)},
  author = {O. Delaigue and L. Coron and P. Brigode and G. Thirel},
  journal = {R News},
  year = {2024},
  note = {R package version 0.3.3},
  url = {https://CRAN.R-project.org/package=airGRteaching},
  doi = {10.32614/CRAN.package.airGRteaching},
}

3.2 Known places where airGRteaching is used