From b2501442035211538d384e6b6ae8b4b2ecca7b71 Mon Sep 17 00:00:00 2001 From: unknown <olivier.delaigue@ANPI1430.antony.irstea.priv> Date: Wed, 7 Dec 2016 13:28:02 +0100 Subject: [PATCH] #4434 using cat to print the criteria value is now not necessary --- inst/doc/airGR.Rmd | 2 -- inst/doc/airGR.html | 28 ++++++++-------------------- man/Calibration.Rd | 6 ------ man/Calibration_Michel.Rd | 5 ----- man/CreateInputsCrit.Rd | 12 ------------ man/CreateInputsModel.Rd | 1 - man/CreateRunOptions.Rd | 2 -- man/ErrorCrit.Rd | 19 +++++-------------- man/ErrorCrit_KGE.Rd | 6 ++++-- man/ErrorCrit_KGE2.Rd | 6 ++++-- man/ErrorCrit_NSE.Rd | 6 ++++-- man/ErrorCrit_RMSE.Rd | 6 ++++-- man/RunModel.Rd | 2 -- man/RunModel_CemaNeigeGR4J.Rd | 2 -- man/RunModel_CemaNeigeGR5J.Rd | 2 -- man/RunModel_CemaNeigeGR6J.Rd | 2 -- man/RunModel_GR1A.Rd | 2 -- man/RunModel_GR2M.Rd | 2 -- man/RunModel_GR4H.Rd | 2 -- man/RunModel_GR4J.Rd | 2 -- man/RunModel_GR5J.Rd | 2 -- man/RunModel_GR6J.Rd | 2 -- 22 files changed, 29 insertions(+), 90 deletions(-) diff --git a/inst/doc/airGR.Rmd b/inst/doc/airGR.Rmd index 247ee2fc..629e4bf9 100644 --- a/inst/doc/airGR.Rmd +++ b/inst/doc/airGR.Rmd @@ -250,10 +250,8 @@ To evaluate the efficiency of the model, it is possible to use the same criterio ```{r} OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -str(OutputsCrit) ``` ```{r} OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -str(OutputsCrit) ``` diff --git a/inst/doc/airGR.html b/inst/doc/airGR.html index 445c8eb9..014d86b9 100644 --- a/inst/doc/airGR.html +++ b/inst/doc/airGR.html @@ -220,10 +220,9 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf </ul> <div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">CalibOptions <-<span class="st"> </span><span class="kw">CreateCalibOptions</span>(<span class="dt">FUN_MOD =</span> RunModel_GR4J, <span class="dt">FUN_CALIB =</span> Calibration_Michel) <span class="kw">str</span>(CalibOptions)</code></pre></div> -<pre><code>## List of 4 +<pre><code>## List of 3 ## $ FixedParam : logi [1:4] NA NA NA NA ## $ SearchRanges : num [1:2, 1:4] 4.59e-05 2.18e+04 -1.09e+04 1.09e+04 4.59e-05 ... -## $ StartParam : num [1:4] 247.151 -0.649 42.098 1.944 ## $ StartParamDistrib: num [1:3, 1:4] 169.017 247.151 432.681 -2.376 -0.649 ... ## - attr(*, "class")= chr [1:3] "CalibOptions" "GR4J" "HBAN"</code></pre> </div> @@ -311,24 +310,13 @@ Param</code></pre></div> <div id="efficiency-criterion" class="section level2"> <h2>Efficiency criterion</h2> <p>To evaluate the efficiency of the model, it is possible to use the same criterion as defined at the calibration step or to use an other criterion.</p> -<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">OutputsCrit <-<span class="st"> </span><span class="kw">ErrorCrit_NSE</span>(<span class="dt">InputsCrit =</span> InputsCrit, <span class="dt">OutputsModel =</span> OutputsModel) -<span class="kw">str</span>(OutputsCrit)</code></pre></div> -<pre><code>## List of 5 -## $ CritValue : num 0.799 -## $ CritName : chr "NSE[Q]" -## $ CritBestValue : num 1 -## $ Multiplier : num -1 -## $ Ind_notcomputed: int [1:40] 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 ...</code></pre> -<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">OutputsCrit <-<span class="st"> </span><span class="kw">ErrorCrit_KGE</span>(<span class="dt">InputsCrit =</span> InputsCrit, <span class="dt">OutputsModel =</span> OutputsModel) -<span class="kw">str</span>(OutputsCrit)</code></pre></div> -<pre><code>## List of 7 -## $ CritValue : num 0.785 -## $ CritName : chr "KGE[Q]" -## $ SubCritValues : num [1:3] 0.898 0.816 1.044 -## $ SubCritNames : chr [1:3] "KGE[Q] rPEARSON(sim vs. obs)" "KGE[Q] STDEVsim/STDEVobs" "KGE[Q] MEANsim/MEANobs" -## $ CritBestValue : num 1 -## $ Multiplier : num -1 -## $ Ind_notcomputed: int [1:40] 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 ...</code></pre> +<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">OutputsCrit <-<span class="st"> </span><span class="kw">ErrorCrit_NSE</span>(<span class="dt">InputsCrit =</span> InputsCrit, <span class="dt">OutputsModel =</span> OutputsModel)</code></pre></div> +<pre><code>## Crit. NSE[Q] = 0.7985</code></pre> +<div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">OutputsCrit <-<span class="st"> </span><span class="kw">ErrorCrit_KGE</span>(<span class="dt">InputsCrit =</span> InputsCrit, <span class="dt">OutputsModel =</span> OutputsModel)</code></pre></div> +<pre><code>## Crit. KGE[Q] = 0.7855</code></pre> +<pre><code>## SubCrit. KGE[Q] cor(sim, obs, "pearson") = 0.8983 +## SubCrit. KGE[Q] sd(sim)/sd(obs) = 0.8163 +## SubCrit. KGE[Q] mean(sim)/mean(obs) = 1.0439</code></pre> </div> </div> diff --git a/man/Calibration.Rd b/man/Calibration.Rd index 8c363568..c1b79711 100644 --- a/man/Calibration.Rd +++ b/man/Calibration.Rd @@ -75,17 +75,11 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", - round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Kling-Gupta Efficiency InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", - round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - - } \author{ Laurent Coron (June 2014) diff --git a/man/Calibration_Michel.Rd b/man/Calibration_Michel.Rd index 8dc0d925..91caa160 100644 --- a/man/Calibration_Michel.Rd +++ b/man/Calibration_Michel.Rd @@ -102,16 +102,11 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", - round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Kling-Gupta Efficiency InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", - round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Claude Michel (August 2013) diff --git a/man/CreateInputsCrit.Rd b/man/CreateInputsCrit.Rd index 7f6e2d26..0a4002d7 100644 --- a/man/CreateInputsCrit.Rd +++ b/man/CreateInputsCrit.Rd @@ -67,7 +67,6 @@ OutputsModel <- RunModel(InputsModel = InputsModel, RunOptions = RunOptions, InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Nash-Sutcliffe Efficiency on log-transformed flows transfo <- "log" @@ -75,8 +74,6 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsMod RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run], transfo = transfo) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", - round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Nash-Sutcliffe Efficiency above a threshold (q75\%) BoolCrit <- rep(TRUE, length(BasinObs$Qmm[Ind_Run])); @@ -85,15 +82,11 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsMod RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run], BoolCrit = BoolCrit) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Kling-Gupta Efficiency InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) -cat(paste("SubCrit ", OutputsCrit$SubCritNames, " ", - round(OutputsCrit$SubCritValues, 4), "\\n", sep = "")) ## efficiency criterion: Kling-Gupta Efficiency below a threshold (q10\%) on log-trqansformed flows transfo <- "log" @@ -103,11 +96,6 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsModel,RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run], BoolCrit = BoolCrit, transfo = transfo) OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) -cat(paste("SubCrit ", OutputsCrit$SubCritNames, " ", - round(OutputsCrit$SubCritValues, 4), "\\n", sep = "")) - - } \author{ Laurent Coron (June 2014) diff --git a/man/CreateInputsModel.Rd b/man/CreateInputsModel.Rd index 463ccadd..5efb8f7e 100644 --- a/man/CreateInputsModel.Rd +++ b/man/CreateInputsModel.Rd @@ -78,7 +78,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) } \author{ diff --git a/man/CreateRunOptions.Rd b/man/CreateRunOptions.Rd index ab45807e..05b97a76 100644 --- a/man/CreateRunOptions.Rd +++ b/man/CreateRunOptions.Rd @@ -111,8 +111,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron (June 2014) diff --git a/man/ErrorCrit.Rd b/man/ErrorCrit.Rd index c035b961..3b6bbb23 100644 --- a/man/ErrorCrit.Rd +++ b/man/ErrorCrit.Rd @@ -3,16 +3,18 @@ \alias{ErrorCrit} \title{Error criterion using the provided function} \usage{ -ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, verbose = TRUE) +ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, warnings = TRUE, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{FUN_CRIT}{[function] error criterion function (e.g. ErrorCrit_RMSE, ErrorCrit_NSE)} +\item{FUN_CRIT}{[function] error criterion function (e.g. \code{ErrorCrit_RMSE}, \code{ErrorCrit_NSE})} -\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} +\item{warnings}{(optional) [boolean] boolean indicating if the warning messages are shown, default = \code{TRUE}} + +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}} } \value{ [list] list containing the function outputs, see \code{\link{ErrorCrit_RMSE}} or \code{\link{ErrorCrit_NSE}} for details @@ -47,7 +49,6 @@ OutputsModel <- RunModel(InputsModel = InputsModel, RunOptions = RunOptions, InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Nash-Sutcliffe Efficiency on log-transformed flows transfo <- "log" @@ -55,7 +56,6 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsMod RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run], transfo = transfo) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Nash-Sutcliffe Efficiency above a threshold (q75\%) BoolCrit <- rep(TRUE, length(BasinObs$Qmm[Ind_Run])) @@ -64,15 +64,11 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsMod RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run], BoolCrit = BoolCrit) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) ## efficiency criterion: Kling-Gupta Efficiency InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) -cat(paste("SubCrit ", OutputsCrit$SubCritNames, " ", - round(OutputsCrit$SubCritValues, 4), "\\n", sep = "")) ## efficiency criterion: Kling-Gupta Efficiency below a threshold (q10\%) on log-trqansformed flows transfo <- "log" @@ -82,11 +78,6 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsMod RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run], BoolCrit = BoolCrit, transfo = transfo) OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) -cat(paste("SubCrit ", OutputsCrit$SubCritNames, " ", - round(OutputsCrit$SubCritValues, 4), "\\n", sep = "")) - - } \author{ Laurent Coron (June 2014) diff --git a/man/ErrorCrit_KGE.Rd b/man/ErrorCrit_KGE.Rd index 9cf7e460..0592ca5a 100644 --- a/man/ErrorCrit_KGE.Rd +++ b/man/ErrorCrit_KGE.Rd @@ -3,14 +3,16 @@ \alias{ErrorCrit_KGE} \title{Error criterion based on the KGE formula} \usage{ -ErrorCrit_KGE(InputsCrit, OutputsModel, verbose = TRUE) +ErrorCrit_KGE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} +\item{warnings}{(optional) [boolean] boolean indicating if the warning messages are shown, default = \code{TRUE}} + +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}} } \value{ [list] list containing the function outputs organised as follows: diff --git a/man/ErrorCrit_KGE2.Rd b/man/ErrorCrit_KGE2.Rd index 2c76f9fd..f16d1544 100644 --- a/man/ErrorCrit_KGE2.Rd +++ b/man/ErrorCrit_KGE2.Rd @@ -3,14 +3,16 @@ \alias{ErrorCrit_KGE2} \title{Error criterion based on the KGE' formula} \usage{ -ErrorCrit_KGE2(InputsCrit, OutputsModel, verbose = TRUE) +ErrorCrit_KGE2(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} +\item{warnings}{(optional) [boolean] boolean indicating if the warning messages are shown, default = \code{TRUE}} + +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}} } \value{ [list] list containing the function outputs organised as follows: diff --git a/man/ErrorCrit_NSE.Rd b/man/ErrorCrit_NSE.Rd index 9f5d67fb..8db06dbd 100644 --- a/man/ErrorCrit_NSE.Rd +++ b/man/ErrorCrit_NSE.Rd @@ -3,14 +3,16 @@ \alias{ErrorCrit_NSE} \title{Error criterion based on the NSE formula} \usage{ -ErrorCrit_NSE(InputsCrit, OutputsModel, verbose = TRUE) +ErrorCrit_NSE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} +\item{warnings}{(optional) [boolean] boolean indicating if the warning messages are shown, default = \code{TRUE}} + +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}} } \value{ [list] list containing the function outputs organised as follows: diff --git a/man/ErrorCrit_RMSE.Rd b/man/ErrorCrit_RMSE.Rd index 9802a29c..35040f56 100644 --- a/man/ErrorCrit_RMSE.Rd +++ b/man/ErrorCrit_RMSE.Rd @@ -3,14 +3,16 @@ \alias{ErrorCrit_RMSE} \title{Error criterion based on the RMSE} \usage{ -ErrorCrit_RMSE(InputsCrit, OutputsModel, verbose = TRUE) +ErrorCrit_RMSE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} +\item{warnings}{(optional) [boolean] boolean indicating if the warning messages are shown, default = \code{TRUE}} + +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}} } \value{ [list] list containing the function outputs organised as follows: diff --git a/man/RunModel.Rd b/man/RunModel.Rd index e7e3e3a9..481ac62b 100644 --- a/man/RunModel.Rd +++ b/man/RunModel.Rd @@ -50,8 +50,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron (June 2014) diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd index d3af641e..04a13d2b 100644 --- a/man/RunModel_CemaNeigeGR4J.Rd +++ b/man/RunModel_CemaNeigeGR4J.Rd @@ -90,8 +90,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Audrey Valéry, Claude Michel, Charles Perrin, Vazken Andréassian (December 2013) diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd index 2031d8fc..21b857d3 100644 --- a/man/RunModel_CemaNeigeGR5J.Rd +++ b/man/RunModel_CemaNeigeGR5J.Rd @@ -91,8 +91,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Audrey Valéry, Claude Michel, Nicolas Le Moine, Charles Perrin, Vazken Andréassian (December 2013) diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd index ab6aa409..143968d0 100644 --- a/man/RunModel_CemaNeigeGR6J.Rd +++ b/man/RunModel_CemaNeigeGR6J.Rd @@ -94,8 +94,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Audrey Valéry, Claude Michel, Charles Perrin, Raji Pushpalatha, Nicolas Le Moine, Vazken Andréassian (December 2013) diff --git a/man/RunModel_GR1A.Rd b/man/RunModel_GR1A.Rd index 1be73d0e..4ef302c8 100644 --- a/man/RunModel_GR1A.Rd +++ b/man/RunModel_GR1A.Rd @@ -74,8 +74,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Claude Michel (March 2015) diff --git a/man/RunModel_GR2M.Rd b/man/RunModel_GR2M.Rd index 05723782..29bc3a96 100644 --- a/man/RunModel_GR2M.Rd +++ b/man/RunModel_GR2M.Rd @@ -73,8 +73,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Claude Michel, Safouane Mouelhi (March 2015) diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd index 9e8e4775..433be0fe 100644 --- a/man/RunModel_GR4H.Rd +++ b/man/RunModel_GR4H.Rd @@ -75,8 +75,6 @@ plot_OutputsModel(OutputsModel=OutputsModel,Qobs=BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT=ErrorCrit_NSE,InputsModel=InputsModel, RunOptions=RunOptions,Qobs=BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit=InputsCrit,OutputsModel=OutputsModel) -cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\\n",sep="")) - } \author{ Laurent Coron (July 2014) diff --git a/man/RunModel_GR4J.Rd b/man/RunModel_GR4J.Rd index 7f584ed8..eb0eddbd 100644 --- a/man/RunModel_GR4J.Rd +++ b/man/RunModel_GR4J.Rd @@ -76,8 +76,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Claude Michel, Charles Perrin (December 2013) diff --git a/man/RunModel_GR5J.Rd b/man/RunModel_GR5J.Rd index bd058061..43527135 100644 --- a/man/RunModel_GR5J.Rd +++ b/man/RunModel_GR5J.Rd @@ -78,8 +78,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Claude Michel, Nicolas Le Moine (December 2013) diff --git a/man/RunModel_GR6J.Rd b/man/RunModel_GR6J.Rd index e5409344..5cc6c960 100644 --- a/man/RunModel_GR6J.Rd +++ b/man/RunModel_GR6J.Rd @@ -80,8 +80,6 @@ plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) -cat(paste(" Crit ", OutputsCrit$CritName, " ", round(OutputsCrit$CritValue, 4), "\\n", sep = "")) - } \author{ Laurent Coron, Claude Michel, Charles Perrin, Raji Pushpalatha, Nicolas Le Moine (December 2013) -- GitLab