Skip to content
Snippets Groups Projects
Commit 50ff5d11 authored by David Dorchies's avatar David Dorchies 🤪
Browse files

docs: add Get started with hydrological indicators

Refs #3
parent 87c1aa91
No related branches found
No related tags found
No related merge requests found
Pipeline #312543 failed
......@@ -20,3 +20,7 @@ Depends:
airGRccia
remotes:
git::https://forgemia.inra.fr/airgriwrm/airgrccia.git
Suggests:
knitr,
rmarkdown
VignetteBuilder: knitr
*.html
*.R
---
title: "seinebasin3"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{seinebasin3}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```
```{r setup}
library(tidyverse)
library(seinebasin3)
```
Cette vignette est un exemple d'utilisation du package *seinebasin3* pour le
calcul des indicateurs hydrologiques sur les débits naturalisés modélisés par
le modèle seinebasin2.
## Chargement des données
Les données de référence sont directement téléchargées depuis la base de données
IN-WOP à partir d'un lien de téléchargement public
```{r}
#| out.width = "100%"
# Définition du lien de téléchargement du fichier
url <-
"https://nextcloud.inrae.fr/s/adinzGa3AmLEXnZ/download?path=%2F03-naturalised_flows%2Fv2.0%2Fhistorical%2Fdata&files=ts_Qsim.tsv"
# Chargement direct du tableau en mémoire
Qsim <- readr::read_tsv(url)
# Affichage des premières lignes du tableau
head(Qsim)
```
Réduisons le nombre de stations étudiées en ne sélectionnant que les colonnes
qui nous intéressent:
```{r}
Qsim <- Qsim[, c("DatesR", "H5920010", "H4340010")]
```
On peut alors visualiser les chroniques de débit simulées sur les stations:
```{r}
#| out.width = "100%"
# Plot du débit sur une sélection de stations
TSstudio::ts_plot(Qsim[, c("DatesR", "H5920010", "H4340010")], slider = TRUE)
```
## Calcul des indicateurs
Le package *seinebasin3* charge automatiquement les fonctions du package *airGRccia*
qui contient les fonctions de calcul des indicateurs hydrologiques.
La documentation de ces fonctions est disponible [sur le site de documentation du
package *airGRccia*](https://airgriwrm.pages.mia.inra.fr/airgrccia/reference).
Le nom de ces fonctions ont le préfixe `calc` (exemple: `calcQMNA5`).
La fonction `calcQindicators` permet de calculer directement une série
d'indicateurs hydrologiques:
```{r}
# Calcul des indicateurs hydrologiques
# Le colonne des dates doit être au format POSIXct ou POSIXlt
Qsim$DatesR <- as.POSIXct(Qsim$DatesR)
indicators <- calcQindicators(Qsim)
indicators
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment