Commit 0057999c authored by Delaigue Olivier's avatar Delaigue Olivier

Merge branch 'screenshots' into 'dev'

Resolve "Update interface screenshots"

Closes #13

See merge request !7
parents 4d4ab42f a282a27d
Package: airGRteaching
Type: Package
Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included)
Version: 0.2.10.54
Date: 2020-06-17
Version: 0.2.10.56
Date: 2020-06-19
Authors@R: c(
person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),
person("Laurent", "Coron", role = c("aut"), comment = c(ORCID = "0000-0002-1503-6204")),
......
......@@ -4,7 +4,7 @@
### 0.2.10.54 Release Notes (2020-06-17)
### 0.2.10.56 Release Notes (2020-06-19)
### Version control and issue tracking
......
......@@ -232,8 +232,8 @@ navbarPage(title = div("airGRteaching",
</a></li><li><a href='https://hydrogr.github.io/airGRteaching/' , target = '_blank', rel = 'noopener noreferrer'><i class='fas fa-at'></i>&nbsp;Website
</a></li><li><a href='https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/', target = '_blank', rel = 'noopener noreferrer'><i class='fab fa-gitlab'></i>&nbsp;GitLab"),
icon = icon("question"),
fluidRow(column(width = 12, a(href = "https://hydrogr.github.io/airGRteaching/fig/airGRteaching_ShinyUi_description.png", target = "_blank", rel = "noopener noreferrer",
img(src = "https://hydrogr.github.io/airGRteaching/fig/airGRteaching_ShinyUi_description.png", height = "770px",
fluidRow(column(width = 12, a(href = "fig/airGRteaching_GUI_Description.png", target = "_blank", rel = "noopener noreferrer",
img(src = "fig/airGRteaching_GUI_Description.png", height = "770px",
alt = "If the image does not appear, click on this link.",
title = "Click to open in a new window")))),
),
......
......@@ -403,7 +403,7 @@ summary {
<p>For this step, you just have to use the <code>PrepGR()</code> function. You have to define:</p>
<ul>
<li><code>ObsDF</code>: <code>data.frame</code> of hydrometeorological observations time series</li>
<li><code>HydroModel</code>: the name of the hydrological model you want to run (GR1A, GR2M, GR4J, GR5J, GR6J or GR4H)</li>
<li><code>HydroModel</code>: the name of the hydrological model you want to run (GR1A, GR2M, GR4J, GR5J, GR6J, GR4H or GR5H)</li>
<li><code>CemaNeige</code>: if you want or not to use the snowmelt and accumulation model</li>
</ul>
<p>If you want to use CemaNeige, you also have to define:</p>
......@@ -452,6 +452,104 @@ summary {
<p><br></p>
</div>
</div>
<div id="formating-outputs" class="section level3">
<h3>Formating outputs</h3>
<p>The call of the <code>as.data.frame()</code> function with <code>PrepGR</code>, <code>CalGR</code> or <code>SimGR</code> objects allows to coerce the outputs to a data frame.</p>
<pre class="r"><code>head(as.data.frame(PREP))</code></pre>
<pre><code>## Dates PotEvap PrecipObs PrecipFracSolid_CemaNeige TempMeanSim_CemaNeige
## 1 1984-01-01 0.2 4.1 NA NA
## 2 1984-01-02 0.2 15.9 NA NA
## 3 1984-01-03 0.3 0.8 NA NA
## 4 1984-01-04 0.3 0.0 NA NA
## 5 1984-01-05 0.1 0.0 NA NA
## 6 1984-01-06 0.3 0.0 NA NA
## Qobs Qsim
## 1 0.6336 NA
## 2 0.8256 NA
## 3 2.9280 NA
## 4 1.8240 NA
## 5 1.5000 NA
## 6 1.3560 NA</code></pre>
<pre class="r"><code>head(as.data.frame(CAL))</code></pre>
<pre><code>## Dates PotEvap PrecipObs PrecipFracSolid_CemaNeige TempMeanSim_CemaNeige
## 1 1990-01-01 0.3 0.0 NA NA
## 2 1990-01-02 0.4 9.3 NA NA
## 3 1990-01-03 0.4 3.2 NA NA
## 4 1990-01-04 0.3 7.3 NA NA
## 5 1990-01-05 0.1 0.0 NA NA
## 6 1990-01-06 0.1 0.0 NA NA
## Qobs Qsim
## 1 1.992 2.523954
## 2 1.800 2.446199
## 3 2.856 2.943436
## 4 2.400 3.286214
## 5 3.312 3.512572
## 6 3.072 3.224969</code></pre>
<pre class="r"><code>head(as.data.frame(SIM))</code></pre>
<pre><code>## Dates PotEvap PrecipObs PrecipFracSolid_CemaNeige TempMeanSim_CemaNeige
## 1 1994-01-01 0.4 2.2 NA NA
## 2 1994-01-02 0.4 0.0 NA NA
## 3 1994-01-03 0.6 0.7 NA NA
## 4 1994-01-04 0.6 3.2 NA NA
## 5 1994-01-05 0.6 35.1 NA NA
## 6 1994-01-06 0.5 21.3 NA NA
## Qobs Qsim
## 1 2.904 3.593023
## 2 2.832 3.414026
## 3 2.364 2.988078
## 4 2.544 2.668972
## 5 2.640 3.526016
## 6 8.928 8.819935</code></pre>
</div>
<div id="formating-outputs-1" class="section level3">
<h3>Formating outputs</h3>
<p>The call of the <code>as.data.frame()</code> function with <code>PrepGR</code>, <code>CalGR</code> or <code>SimGR</code> objects allows to coerce the outputs to a data frame.</p>
<pre class="r"><code>head(as.data.frame(PREP))</code></pre>
<pre><code>## Dates PotEvap PrecipObs PrecipFracSolid_CemaNeige TempMeanSim_CemaNeige
## 1 1984-01-01 0.2 4.1 NA NA
## 2 1984-01-02 0.2 15.9 NA NA
## 3 1984-01-03 0.3 0.8 NA NA
## 4 1984-01-04 0.3 0.0 NA NA
## 5 1984-01-05 0.1 0.0 NA NA
## 6 1984-01-06 0.3 0.0 NA NA
## Qobs Qsim
## 1 0.6336 NA
## 2 0.8256 NA
## 3 2.9280 NA
## 4 1.8240 NA
## 5 1.5000 NA
## 6 1.3560 NA</code></pre>
<pre class="r"><code>head(as.data.frame(CAL))</code></pre>
<pre><code>## Dates PotEvap PrecipObs PrecipFracSolid_CemaNeige TempMeanSim_CemaNeige
## 1 1990-01-01 0.3 0.0 NA NA
## 2 1990-01-02 0.4 9.3 NA NA
## 3 1990-01-03 0.4 3.2 NA NA
## 4 1990-01-04 0.3 7.3 NA NA
## 5 1990-01-05 0.1 0.0 NA NA
## 6 1990-01-06 0.1 0.0 NA NA
## Qobs Qsim
## 1 1.992 2.523954
## 2 1.800 2.446199
## 3 2.856 2.943436
## 4 2.400 3.286214
## 5 3.312 3.512572
## 6 3.072 3.224969</code></pre>
<pre class="r"><code>head(as.data.frame(SIM))</code></pre>
<pre><code>## Dates PotEvap PrecipObs PrecipFracSolid_CemaNeige TempMeanSim_CemaNeige
## 1 1994-01-01 0.4 2.2 NA NA
## 2 1994-01-02 0.4 0.0 NA NA
## 3 1994-01-03 0.6 0.7 NA NA
## 4 1994-01-04 0.6 3.2 NA NA
## 5 1994-01-05 0.6 35.1 NA NA
## 6 1994-01-06 0.5 21.3 NA NA
## Qobs Qsim
## 1 2.904 3.593023
## 2 2.832 3.414026
## 3 2.364 2.988078
## 4 2.544 2.668972
## 5 2.640 3.526016
## 6 8.928 8.819935</code></pre>
</div>
<div id="pre-defined-graphical-plots" class="section level3">
<h3>Pre-defined graphical plots</h3>
<div id="static-plots" class="section level4">
......@@ -483,25 +581,26 @@ summary {
<p><br></p>
</div>
</div>
<div id="shiny-interface" class="section level3">
<h3><em>Shiny</em> interface</h3>
<p>The <strong><font color="#0BA6AA">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 page.</p>
<p>The <code>ShinyGR()</code> function just needs:</p>
<div id="graphical-user-interface" class="section level3">
<h3>Graphical user interface</h3>
<p>The <strong><font color="#0BA6AA">airGRteaching</font></strong> package also provides the <code>ShinyGR()</code> function, which allows to launch a graphical user interface using the <em>shiny</em> package.</p>
<p>The <code>ShinyGR()</code> function needs at least:</p>
<ul>
<li><code>ObsDF</code>: a <code>data.frame</code> (or a <code>list</code> of <code>data.frame</code>)</li>
<li><code>SimPer</code>: a vector (or list of vectors) of 2 dates to define the simulation period(s)</li>
<li><code>ObsDF</code>: a (list of) <code>data.frame</code> (or independant vector instead, see <code>?ShinyGR</code>)</li>
<li><code>SimPer</code>: a (list of) vector(s) of 2 dates to define the simulation period(s)</li>
</ul>
<pre class="r"><code>ShinyGR(ObsDF = BasinObs, SimPer = c(&quot;1994-01-01&quot;, &quot;1998-12-31&quot;))</code></pre>
<p>Only daily models are currently available (GR4J, GR5J, GR6J + CemaNeige).</p>
<p>Only monthly and daily models are currently available (GR2M, GR4J, GR5J, GR6J + CemaNeige).</p>
<p>If you want to use CemaNeige, you also have to define the same arguments desribed above for the <code>PrepGR()</code> function.</p>
It is also possible to change the interface look; different themes are proposed (<code>theme</code> argument).
<div>
<center>
<image src="fig/theme_rstudio.jpg" width="32%" height="32%"> <image src="fig/theme_cerulean.jpg" width="32%" height="32%"> <image src="fig/theme_cyborg.jpg" width="32%" height="32%"></img>
<image src="fig/airGRteaching_GUI_MD_theme-RStudio_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Cerulean_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Cyborg_544x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Flatly_550x300.png" width="24%" height="24%">
</center>
</div>
<div>
<center>
<image src="fig/theme_flatly.jpg" width="32%" height="32%"> <image src="fig/theme_united.jpg" width="32%" height="32%"> <image src="fig/theme_yeti.jpg" width="32%" height="32%">
<image src="fig/airGRteaching_GUI_MD_theme-Inrae_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Saclay_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-United_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Yeti_550x300.png" width="24%" height="24%">
</center>
</div>
</div>
......
This diff is collapsed.
......@@ -213,7 +213,6 @@ Only monthly and daily models are currently available (GR2M, GR4J, GR5J, GR6J +
If you want to use CemaNeige, you also have to define the same arguments desribed above for the `PrepGR()` function.
It is also possible to change the interface look; different themes are proposed (`theme` argument).
<div><center><image src="fig/theme_rstudio.jpg" width="32%" height="32%"> <image src="fig/theme_cerulean.jpg" width="32%" height="32%"> <image src="fig/theme_cyborg.jpg" width="32%" height="32%"></img></center></div>
<div><center><image src="fig/theme_flatly.jpg" width="32%" height="32%"> <image src="fig/theme_united.jpg" width="32%" height="32%"> <image src="fig/theme_yeti.jpg" width="32%" height="32%"></center></div>
<div><center><image src="fig/airGRteaching_GUI_MD_theme-RStudio_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Cerulean_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Cyborg_544x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Flatly_550x300.png" width="24%" height="24%"></center></div>
<div><center><image src="fig/airGRteaching_GUI_MD_theme-Inrae_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Saclay_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-United_550x300.png" width="24%" height="24%"> <image src="fig/airGRteaching_GUI_MD_theme-Yeti_550x300.png" width="24%" height="24%"></center></div>
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