Commit aa76f894 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v0.2.8.7 DOC: only one help page (alias = plot) for all plot.* funs

parent 6d53f6ff
Package: airGRteaching
Type: Package
Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included)
Version: 0.2.8.6
Version: 0.2.8.7
Date: 2020-02-05
Authors@R: c(
person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),
......
......@@ -14,7 +14,7 @@ output:
### 0.2.8.5 Release Notes (2020-02-05)
### 0.2.8.7 Release Notes (2020-02-05)
#### New features
......@@ -39,6 +39,8 @@ output:
- the <code>dyplot.PrepGR()</code>, <code>dyplot.CalGR()</code> and <code>dyplot.SimGR()</code> functions are no longer exported.
- the is now only one help page for all <code>plot.&#42;()</code> functions (use <code>?plot</code> to call it).
____________________________________________________________________________________
......
\encoding{UTF-8}
\name{plot.CalGR}
\alias{plot.CalGR}
\title{Time series plotting of GR calibration objects}
\usage{
\method{plot}{CalGR}(x, xlab = NULL, ylab = NULL, main = NULL, which = c("perf", "iter", "ts"), ...)
}
\arguments{
\item{x}{[object of class \emph{CalGR}] see \code{\link{CalGR}} for details}
\item{xlab}{(optional) [character] a label for the x-axis when \code{which = "iter"} (see \code{\link{title}})}
\item{ylab}{(optional) [character] a label for the y-axis when \code{which = "iter"} (vector of 1 or 2 values for flow and rainfall respectively; see \code{\link{title}})}
\item{main}{(optional) [character] a main title for the plot (see \code{\link{title}})}
\item{which}{[character] choice of the plot type (\code{"perf"} (default): plot diagnostics; \code{"iter"}: parameter and calibration criterion values during the iterations of the steepest descent step of the airGR calibration algorithm; \code{"ts"}: time series of observed precipitation and observed and simulated flows)}
\item{...}{other parameters to be passed through to plotting functions}
}
\description{Time series plotting of GR calibration objects}
\seealso{
\code{\link{CalGR}}, \code{\link{plot.OutputsModel}}
}
\author{Olivier Delaigue}
\examples{
library(airGRteaching)
## data.frame of observed data
data(L0123001, package = "airGR")
BasinObs2 <- BasinObs[, c("DatesR", "P", "E", "Qmm", "T")]
## Preparation of observed data for modelling
PREP <- PrepGR(ObsDF = BasinObs2, HydroModel = "GR5J", CemaNeige = TRUE)
## Calibration step
CAL <- CalGR(PrepGR = PREP, CalCrit = "KGE2",
WupPer = NULL, CalPer = c("1990-01-01", "1993-12-31"))
plot(CAL, which = "perf")
plot(CAL, which = "ts")
plot(CAL, which = "iter")
}
\encoding{UTF-8}
\name{plot.PrepGR}
\name{plot}
\alias{plot}
\alias{plot.PrepGR}
\alias{plot.CalGR}
\alias{plot.SimGR}
\title{Time series plotting GR observation objects}
\usage{
\method{plot}{PrepGR}(x, type = "l", col.Precip = "royalblue", col.Q = "black", col.na = "grey",
xlab = NULL, ylab = NULL, main = NULL,
plot.na = TRUE, ...)
\method{plot}{PrepGR}(x, type = "l",
col.Precip = "royalblue", col.Q = "black", col.na = "grey",
xlab = NULL, ylab = NULL, main = NULL,
plot.na = TRUE, ...)
\method{plot}{CalGR}(x, xlab = NULL, ylab = NULL, main = NULL,
which = c("perf", "iter", "ts"), ...)
\method{plot}{SimGR}(x, ...)
}
......@@ -31,6 +41,9 @@
\item{plot.na}{[boolean] boolean indicating if the missing values are plotted on the x-axis}
\item{...}{other parameters to be passed through to plotting functions}
\item{which}{[character] choice of the plot type (\code{"perf"} (default): plot diagnostics; \code{"iter"}: parameter and calibration criterion values during the iterations of the steepest descent step of the airGR calibration algorithm; \code{"ts"}: time series of observed precipitation and observed and simulated flows)}
}
......
\encoding{UTF-8}
\name{plot.SimGR}
\alias{plot.SimGR}
\title{Synthetic plotting of of GR model outputs}
\usage{
\method{plot}{SimGR}(x, ...)
}
\arguments{
\item{x}{[object of class \emph{SimGR}] see \code{\link{SimGR}} for details}
\item{...}{other parameters to be passed through to plotting functions}
}
\value{
Screen plot window
}
\description{
Function that creates a screen plot giving an overview of the GR model outputs
}
\details{
Dashboard of results including various graphs (depending on the model): \cr
(1) time series of total precipitation and simulated flows (and observed flows if provided) \cr
(2) interannual median monthly simulated flow (and observed flows if provided) \cr
(3) correlation plot between simulated and observed flows (if observed flows provided) \cr
(4) cumulative frequency plot for simulated flows (and observed flows if provided)
}
\seealso{
\code{\link{SimGR}}, \code{\link{plot.OutputsModel}}
}
\examples{
library(airGRteaching)
## data.frame of observed data
data(L0123001, package = "airGR")
BasinObs2 <- BasinObs[, c("DatesR", "P", "E", "Qmm", "T")]
## Preparation of observed data for modelling
PREP <- PrepGR(ObsDF = BasinObs2, HydroModel = "GR4J", CemaNeige = FALSE)
## Calibration step
CAL <- CalGR(PrepGR = PREP, CalCrit = "KGE2",
WupPer = NULL, CalPer = c("1990-01-01", "1993-12-31"))
## Simulation step using the result of the automatic calibration method to set the model parameters
SIM <- SimGR(PrepGR = PREP, CalGR = CAL, EffCrit = "KGE2",
WupPer = NULL, SimPer = c("1994-01-01", "1998-12-31"))
plot(SIM)
}
\author{
Olivier Delaigue, Laurent Coron
}
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