Commit 2440f73b authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

Merge branch '30-clean-namespace' into 'dev'

Resolve "Clean NAMESPACE"

Closes #30

See merge request !12
parents 85171187 e3f2c458
Pipeline #18133 passed with stages
in 1 minute and 28 seconds
Package: airGRteaching
Type: Package
Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included)
Version: 0.2.10.79
Date: 2020-12-03
Version: 0.2.10.85
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"),
person("Laurent", "Coron", role = c("aut"), comment = c(ORCID = "0000-0002-1503-6204")),
......
......@@ -2,35 +2,32 @@
Modelling functions:
======================
PrepGR Creation of the inputs required to the CalGR
and SimGR functions
CalGR Calibration algorithm optimises the error
criterion selected as objective function
SimGR Run GR hydrological models
PrepGR Creation of the inputs required to the CalGR
and SimGR functions
CalGR Calibration algorithm optimises the error
criterion selected as objective function
SimGR Run GR hydrological models
Summarizing functions:
======================
as.data.frame Create a data.frame from outputs of PrepGR,
CalGR or SimGR
as.data.frame Create a data.frame from outputs of PrepGR,
CalGR or SimGR
Plotting functions:
======================
dyplot Interactive time series plotting of PrepGR, CalGR
and SimGR objects
plot.PrepGR Time series plotting GR objects from inputs
plot.CalGR Plotting of the evolution of parameters and
objective function during the calibration step,
and time series plotting GR objects from calibration
outputs
plot.SimGR Synthetic plotting of model outputs
dyplot Interactive plots for time series of PrepGR, CalGR
and SimGR objects
plot Static plots for time series of PrepGR, CalGR
and SimGR objects. Also plot of the evolution
of parameters and objective function during
the calibration step for CalGR object
Shiny interface:
======================
ShinyGR Interactive Web applications to run the GR2M, GR4J, GR5J
and GR6J hydrological models whith or without CemaNeige
ShinyGR Interactive Web applications to run the GR2M, GR4J, GR5J
and GR6J hydrological models whith or without CemaNeige
......@@ -4,39 +4,30 @@
#####################################
## S3 methods ##
#####################################
S3method("plot","PrepGR")
S3method("plot","CalGR")
S3method("plot","SimGR")
S3method("dyplot","default")
S3method("dyplot","PrepGR")
S3method("dyplot","CalGR")
S3method("dyplot","SimGR")
S3method("as.data.frame", "airGRt")
S3method(as.data.frame, airGRt)
S3method(dyplot, default)
S3method(dyplot, PrepGR)
S3method(dyplot, CalGR)
S3method(dyplot, SimGR)
S3method(plot, PrepGR)
S3method(plot, CalGR)
S3method(plot, SimGR)
#####################################
## Export ##
#####################################
export(CalGR)
export(PrepGR)
export(CalGR)
export(SimGR)
export(plot)
export(plot.PrepGR)
export(plot.CalGR)
export(plot.SimGR)
export(dyplot)
export(dyplot.default)
#export(dyplot.PrepGR)
#export(dyplot.CalGR)
#export(dyplot.SimGR)
export(ShinyGR)
export(as.data.frame.airGRt)
export(.CheckUrl)
export(.DiagramGR)
export(.TypeModelGR)
export(.StartStop)
export(.DyShadingMulti)
export(.CheckUrl)
export(.StartStop)
export(.TypeModelGR)
......
......@@ -4,7 +4,7 @@
### 0.2.10.79 Release Notes (2020-12-03)
### 0.2.10.85 Release Notes (2020-12-04)
#### CRAN-compatibility updates
......@@ -20,6 +20,8 @@
- the <code>theme</code> agument of the <code>ShinyGR()<code> function now uses partial matching
- the <code>as.data.frame.airGRt())</code> , <code>plot</code>, <code>plot.PrepGR()</code>, <code>plot.CalGR()</code> and <code>plot.SimGR()</code> functions are no longer exported by the namespace
____________________________________________________________________________________
......
......@@ -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