Commit 3e7eac8f authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v0.2.10.84 docs(man): review plot and dyplot descriptions

parent b27ec4b3
Pipeline #18131 passed with stages
in 1 minute and 24 seconds
Package: airGRteaching
Type: Package
Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included)
Version: 0.2.10.83
Version: 0.2.10.84
Date: 2020-12-04
Authors@R: c(
person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),
......
......@@ -4,7 +4,7 @@
### 0.2.10.83 Release Notes (2020-12-04)
### 0.2.10.84 Release Notes (2020-12-04)
#### CRAN-compatibility updates
......
......@@ -4,10 +4,10 @@
\alias{dyplot}
\title{Interactive time series plotting of GR data}
\title{Interactive plots for time series of PrepGR, CalGR and SimGR objects}
\description{Interactive time series plotting of objects of classes \emph{PrepGR}, \emph{CalGR} or \emph{SimGR}.}
\description{Interactive plots for time series of \emph{PrepGR}, \emph{CalGR} and \emph{SimGR} objects.}
\usage{
......
......@@ -6,10 +6,12 @@
\alias{plot.SimGR}
\title{Time series plotting GR observation objects}
\title{Static plots for time series of PrepGR, CalGR and SimGR objects}
\description{Time series plotting GR observation objects}
\description{
Static plots for time series of \emph{PrepGR}, \emph{CalGR} and \emph{SimGR} objects.
Also plot of the evolution of parameters and objective function during the calibration step for CalGR object.}
\usage{
......@@ -27,7 +29,7 @@
\arguments{
\item{x}{[object of class \emph{PrepGR}] see \code{\link{PrepGR}} for details}
\item{x}{[object of class \emph{PrepGR}, \emph{CalGR} or \emph{SimGR}] see \code{\link{PrepGR}}, \code{\link{CalGR}}, \code{\link{SimGR}} for details}
\item{type}{[character] the type of plot that should be drawn (see \code{\link[graphics]{plot}} for details)}
......@@ -45,9 +47,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)}
\item{...}{other parameters to be passed through to plotting functions}
}
......
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