From 6991a504e69925a0a721782fdac003fd9e2ab1fe Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Tue, 13 Apr 2021 16:15:43 +0200
Subject: [PATCH] docs(man): add missing arguments in RunModel and
Calibration_Michel help pages - fix code/documentation mismatches* Refs #110
---
man/Calibration_Michel.Rd | 4 +++-
man/RunModel.Rd | 4 +++-
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/man/Calibration_Michel.Rd b/man/Calibration_Michel.Rd
index 60439df6..28de8c44 100644
--- a/man/Calibration_Michel.Rd
+++ b/man/Calibration_Michel.Rd
@@ -19,7 +19,7 @@ Then a steepest descent local search algorithm is performed, starting from the r
\usage{
Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
- FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE)
+ FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE, ...)
}
@@ -39,6 +39,8 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
\item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the \code{FUN_MOD} used is native in the package \code{FUN_TRANSFO} is automatically defined}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}}
+
+\item{...}{(optional) arguments to pass to \code{\link{RunModel}}}
}
diff --git a/man/RunModel.Rd b/man/RunModel.Rd
index 2e76d41d..6762ed73 100644
--- a/man/RunModel.Rd
+++ b/man/RunModel.Rd
@@ -15,7 +15,7 @@ Function which performs a single model run with the provided function over the s
\usage{
-RunModel(InputsModel, RunOptions, Param, FUN_MOD)
+RunModel(InputsModel, RunOptions, Param, FUN_MOD, ...)
%
%\method{[}{OutputsModel}(x, i)
}
@@ -29,6 +29,8 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD)
\item{Param}{[numeric] vector of model parameters (See details for SD lag model)}
\item{FUN_MOD}{[function] hydrological model function (e.g. \code{\link{RunModel_GR4J}}, \code{\link{RunModel_CemaNeigeGR4J}})}
+
+\item{...}{(optional) arguments to pass to \code{FUN_MOD}}
%
%\item{x}{[InputsModel] object of class InputsModel}
%
--
GitLab