Commit 4042ecb0 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v0.2.10.112 docs(man): add hyperlinks and/or example to plot and dyplot functions in all help pages

parent c7067c1f
Pipeline #20603 passed with stages
in 2 minutes and 6 seconds
Package: airGRteaching Package: airGRteaching
Type: Package Type: Package
Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included) Title: Teaching Hydrological Modelling with the GR Rainfall-Runoff Models ('Shiny' Interface Included)
Version: 0.2.10.111 Version: 0.2.10.112
Date: 2021-01-23 Date: 2021-01-23
Authors@R: c( Authors@R: c(
person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"), person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@inrae.fr"),
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
### 0.2.10.111 Release Notes (2021-01-23) ### 0.2.10.112 Release Notes (2021-01-23)
#### New features #### New features
......
...@@ -44,7 +44,13 @@ CalGR(PrepGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"), ...@@ -44,7 +44,13 @@ CalGR(PrepGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\seealso{ \seealso{
airGRteaching
\code{\link{plot}} and \code{\link{dyplot}}
functions to display static and dynamic plots
\cr\cr
airGR
\code{\link[airGR]{CreateRunOptions}}, \code{\link[airGR]{CreateInputsCrit}}, \code{\link[airGR]{CreateCalibOptions}}, \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}, \code{\link[airGR]{ErrorCrit_KGE}}, \code{\link[airGR]{ErrorCrit_KGE2}}, \code{\link[airGR]{Calibration_Michel}} \code{\link[airGR]{CreateRunOptions}}, \code{\link[airGR]{CreateInputsCrit}}, \code{\link[airGR]{CreateCalibOptions}}, \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}, \code{\link[airGR]{ErrorCrit_KGE}}, \code{\link[airGR]{ErrorCrit_KGE2}}, \code{\link[airGR]{Calibration_Michel}}
functions
} }
\details{ \details{
...@@ -67,7 +73,23 @@ PREP <- PrepGR(ObsDF = BasinObs2, HydroModel = "GR4J", CemaNeige = TRUE) ...@@ -67,7 +73,23 @@ PREP <- PrepGR(ObsDF = BasinObs2, HydroModel = "GR4J", CemaNeige = TRUE)
## Calibration step ## Calibration step
CAL <- CalGR(PrepGR = PREP, CalCrit = "KGE2", CAL <- CalGR(PrepGR = PREP, CalCrit = "KGE2",
WupPer = NULL, CalPer = c("1990-01-01", "1993-12-31")) WupPer = NULL, CalPer = c("1990-01-01", "1993-12-31"))
## Structure of CalGR object
str(CAL) str(CAL)
## Parameter and criterion evolution during
## the steepest descent step of the calibration algorithm
plot(CAL, which = "iter")
## Plot diagnostics
plot(CAL, which = "perf")
## Static plot of observed and simulated time series
plot(CAL)
## Dynamic plot of observed and simulated time series
dyplot(CAL)
} }
...@@ -51,7 +51,13 @@ PrepGR(ObsDF = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL, ...@@ -51,7 +51,13 @@ PrepGR(ObsDF = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
\seealso{ \seealso{
airGRteaching
\code{\link{plot}} and \code{\link{dyplot}}
functions to display static and dynamic plots
\cr\cr
airGR
\code{\link[airGR]{CreateInputsModel}} \code{\link[airGR]{CreateInputsModel}}
function
} }
...@@ -75,8 +81,17 @@ BasinObs2 <- BasinObs[, c("DatesR", "P", "E", "Qmm", "T")] ...@@ -75,8 +81,17 @@ BasinObs2 <- BasinObs[, c("DatesR", "P", "E", "Qmm", "T")]
## Preparation of observed data for modelling when inputs set by using a data.frame ## Preparation of observed data for modelling when inputs set by using a data.frame
PREP <- PrepGR(ObsDF = BasinObs2, HydroModel = "GR4J", CemaNeige = FALSE) PREP <- PrepGR(ObsDF = BasinObs2, HydroModel = "GR4J", CemaNeige = FALSE)
## Structure of PrepGR object
str(PREP) str(PREP)
## Static plot of observed time series
plot(PREP)
## Dynamic plot of observed time series
dyplot(PREP)
## Preparation of observed data for modelling when inputs set by using independant vectors ## Preparation of observed data for modelling when inputs set by using independant vectors
PREP <- PrepGR(DatesR = BasinObs2$DatesR, Precip = BasinObs2$P, PREP <- PrepGR(DatesR = BasinObs2$DatesR, Precip = BasinObs2$P,
......
...@@ -50,7 +50,13 @@ SimGR(PrepGR, CalGR = NULL, Param, EffCrit = c("NSE", "KGE", "KGE2", "RMSE"), ...@@ -50,7 +50,13 @@ SimGR(PrepGR, CalGR = NULL, Param, EffCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\seealso{ \seealso{
airGRteaching
\code{\link{plot}} and \code{\link{dyplot}}
functions to display static and dynamic plots
\cr\cr
airGR
\code{\link[airGR]{CreateRunOptions}}, \code{\link[airGR]{CreateInputsCrit}}, \code{\link[airGR]{RunModel}}, \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}, \code{\link[airGR]{ErrorCrit_KGE}}, \code{\link[airGR]{ErrorCrit_KGE2}} \code{\link[airGR]{CreateRunOptions}}, \code{\link[airGR]{CreateInputsCrit}}, \code{\link[airGR]{RunModel}}, \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}, \code{\link[airGR]{ErrorCrit_KGE}}, \code{\link[airGR]{ErrorCrit_KGE2}}
functions
} }
...@@ -83,6 +89,18 @@ SIM <- SimGR(PrepGR = PREP, Param = CAL, EffCrit = "KGE2", ...@@ -83,6 +89,18 @@ SIM <- SimGR(PrepGR = PREP, Param = CAL, EffCrit = "KGE2",
## Simulation step using model parameters set by the user ## Simulation step using model parameters set by the user
SIM <- SimGR(PrepGR = PREP, Param = c(270.426, 0.984, 108.853, 2.149), EffCrit = "KGE2", SIM <- SimGR(PrepGR = PREP, Param = c(270.426, 0.984, 108.853, 2.149), EffCrit = "KGE2",
WupPer = NULL, SimPer = c("1994-01-01", "1998-12-31")) WupPer = NULL, SimPer = c("1994-01-01", "1998-12-31"))
## Structure of SimGR object
str(SIM) str(SIM)
## Plot diagnostics
plot(SIM)
## Static plot of observed and simulated time series
plot(SIM, which = "ts")
## Dynamic plot of observed and simulated time series
dyplot(SIM)
} }
...@@ -50,6 +50,8 @@ ...@@ -50,6 +50,8 @@
\seealso{ \seealso{
airGRteaching static \code{\link{plot}} functions
\cr\cr
\code{\link{PrepGR}}, \code{\link{CalGR}}, \code{\link{SimGR}} \code{\link{PrepGR}}, \code{\link{CalGR}}, \code{\link{SimGR}}
} }
......
...@@ -54,7 +54,15 @@ Also plot of the evolution of parameters and objective function during the cali ...@@ -54,7 +54,15 @@ Also plot of the evolution of parameters and objective function during the cali
\seealso{ \seealso{
\code{\link{PrepGR}} airGR
\code{\link[airGR]{plot.OutputsModel}}
function
\cr\cr
airGRteaching
\code{\link{dyplot}}
function to display dynamic plots
\cr\cr
\code{\link{PrepGR}}, \code{\link{CalGR}}, \code{\link{SimGR}}
} }
......
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