From 0c1c04d7de1a3d55cf49c5c2e428066aa297ea24 Mon Sep 17 00:00:00 2001 From: Delaigue Olivier <olivier.delaigue@irstea.priv> Date: Wed, 29 May 2019 08:46:18 +0200 Subject: [PATCH] v1.2.16.5 DOC: datails part of plot.OutputsModel doc reformatted --- DESCRIPTION | 2 +- NEWS.rmd | 2 +- man/plot.OutputsModel.Rd | 34 +++++++++++++++++++--------------- 3 files changed, 21 insertions(+), 17 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a0444ed6..4974dc87 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: airGR Type: Package Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling -Version: 1.2.16.4 +Version: 1.2.16.5 Date: 2019-05-24 Authors@R: c( person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")), diff --git a/NEWS.rmd b/NEWS.rmd index a654d363..02290d96 100644 --- a/NEWS.rmd +++ b/NEWS.rmd @@ -14,7 +14,7 @@ output: -### 1.2.16.4 Release Notes (2019-05-23) +### 1.2.16.5 Release Notes (2019-05-23) #### New features diff --git a/man/plot.OutputsModel.Rd b/man/plot.OutputsModel.Rd index 010a11ac..f8abac14 100644 --- a/man/plot.OutputsModel.Rd +++ b/man/plot.OutputsModel.Rd @@ -57,21 +57,25 @@ Function which creates a screen plot giving an overview of the model outputs. \details{ -Dashboard of results including various graphs (depending on the model):\cr - - \describe{\code{"Precip"}}: {time series of total precipitation} - \describe{\code{"PotEvap"}}: {time series of potential evapotranspiration} - \describe{\code{"Temp"}}: {time series of temperature (plotted only if CemaNeige is used)} - \describe{\code{"SnowPack"}}: {time series of snow water equivalent (plotted only if CemaNeige is used)} - \describe{\code{"Flows"}}: {time series of simulated flows (and observed flows if provided)} - \describe{\code{"Regime"}}: {interannual median monthly simulated flow (and observed flows if provided)} - \describe{\code{"CorQQ"}}: {correlation plot between simulated and observed flows (only if observed flows provided)} - \describe{\code{"CumFreq"}}: {cumulative frequency plot for simulated flows (and observed flows if provided)} - \cr\cr - \describe{\code{"perf"}}: {corresponds to \code{"Error"}, \code{"Regime"}, \code{"CumFreq"} and \code{"CorQQ"}} - \describe{\code{"ts"}}: {corresponds to \code{"Precip"}, \code{"PotEvap"}, \code{"Temp"}, \code{"SnowPack"} and \code{"Flows"}} - \describe{\code{"synth"}}: {corresponds to \code{"Precip"}, \code{"Temp"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Regime"}, \code{"CumFreq"} and \code{"CorQQ"}} - \describe{\code{"all"}}: {corresponds to \code{"Precip"}, \code{"PotEvap"}, \code{"Temp"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Error"}, \code{"Regime"}, \code{"CumFreq"} and \code{"CorQQ"}} +Different types of graphs are available (depending on the model): +\itemize{ + \item \code{"Precip"}: time series of total precipitation + \item \code{"PotEvap"}: time series of potential evapotranspiration + \item \code{"Temp"}: time series of temperature (plotted only if CemaNeige is used) + \item \code{"SnowPack"}: time series of snow water equivalent (plotted only if CemaNeige is used) + \item \code{"Flows"}: time series of simulated flows (and observed flows if provided) + \item \code{"Regime"}: interannual median monthly simulated flow (and observed flows if provided) + \item \code{"CorQQ"}: correlation plot between simulated and observed flows (only if observed flows provided) + \item \code{"CumFreq"}: cumulative frequency plot for simulated flows (and observed flows if provided) +} + +Different dashboard of results including various graphs are available: +\itemize{ + \item \code{"perf"}: corresponds to \code{"Error"}, \code{"Regime"}, \code{"CumFreq"} and \code{"CorQQ"} + \item \code{"ts"}: corresponds to \code{"Precip"}, \code{"PotEvap"}, \code{"Temp"}, \code{"SnowPack"} and \code{"Flows"} + \item \code{"synth"}: corresponds to \code{"Precip"}, \code{"Temp"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Regime"}, \code{"CumFreq"} and \code{"CorQQ"} + \item \code{"all"}: corresponds to \code{"Precip"}, \code{"PotEvap"}, \code{"Temp"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Error"}, \code{"Regime"}, \code{"CumFreq"} and \code{"CorQQ"} + } } \author{ -- GitLab