From 2fc3c4cf851a4569a0a7689950cca6b4f8b5eae2 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.priv>
Date: Wed, 22 May 2019 11:04:20 +0200
Subject: [PATCH] v1.2.16.3 DOC: plot.OutputsModel doc improved and update (all
the grphical outputs are detailed)
---
DESCRIPTION | 2 +-
NEWS.rmd | 2 +-
man/plot.OutputsModel.Rd | 26 ++++++++++++++++----------
3 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 0859ae20..1de6906e 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.2
+Version: 1.2.16.3
Date: 2019-05-22
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 a11d9c27..ee6c69e8 100644
--- a/NEWS.rmd
+++ b/NEWS.rmd
@@ -14,7 +14,7 @@ output:
-### 1.2.16.2 Release Notes (2019-05-22)
+### 1.2.16.3 Release Notes (2019-05-22)
#### New features
diff --git a/man/plot.OutputsModel.Rd b/man/plot.OutputsModel.Rd
index bdf878dc..010a11ac 100644
--- a/man/plot.OutputsModel.Rd
+++ b/man/plot.OutputsModel.Rd
@@ -20,7 +20,7 @@
\arguments{
-\item{x}{[object of class \emph{OutputsModel}] list of model outputs (which must at least include DatesR, Precip and Qsim) [POSIXlt, mm, mm]}
+\item{x}{[object of class \emph{OutputsModel}] list of model outputs (which must at least include DatesR, Precip and Qsim) [POSIXlt, mm/time step, mm/time step]}
\item{Qobs}{(optional) [numeric] time series of observed flow (for the same time steps than simulated) [mm/time step]}
@@ -28,7 +28,7 @@
\item{BasinArea}{(optional) [numeric] basin area [km2], used to plot flow axes in m3/s}
-\item{which}{(optional) [character] choice of plots \cr (e.g. c(\code{"Precip"}, \code{"Temp"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Regime"}, \code{"CumFreq"}, \code{"CorQQ"})), default = \code{"synth"}}
+\item{which}{(optional) [character] choice of plots \cr (e.g. c(\code{"Precip"}, \code{"Temp"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Regime"}, \code{"CumFreq"}, \code{"CorQQ"})), default = \code{"synth"}, see details below}
\item{log_scale}{(optional) [boolean] indicating if the flow axis is to be logarithmic, default = \code{FALSE}}
@@ -58,15 +58,21 @@ 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
- (1) time series of total precipitation\cr
- (2) time series of temperature (plotted only if CemaNeige is used)\cr
- (3) time series of snow pack (plotted only if CemaNeige is used)\cr
- (4) time series of simulated flows (and observed flows if provided)\cr
- (5) interannual median monthly simulated flow (and observed flows if provided)\cr
- (6) correlation plot between simulated and observed flows (if observed flows provided)\cr
- (7) cumulative frequency plot for simulated flows (and observed flows if provided)
-}
+ \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"}}
+}
\author{
Laurent Coron, Olivier Delaigue, Guillaume Thirel
--
GitLab