Commit 6991a504 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

docs(man): add missing arguments in RunModel and Calibration_Michel help pages

- fix code/documentation mismatches*
Refs #110
Showing with 6 additions and 2 deletions
+6 -2
...@@ -19,7 +19,7 @@ Then a steepest descent local search algorithm is performed, starting from the r ...@@ -19,7 +19,7 @@ Then a steepest descent local search algorithm is performed, starting from the r
\usage{ \usage{
Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, 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, ...@@ -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{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{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}}}
} }
......
...@@ -15,7 +15,7 @@ Function which performs a single model run with the provided function over the s ...@@ -15,7 +15,7 @@ Function which performs a single model run with the provided function over the s
\usage{ \usage{
RunModel(InputsModel, RunOptions, Param, FUN_MOD) RunModel(InputsModel, RunOptions, Param, FUN_MOD, ...)
% %
%\method{[}{OutputsModel}(x, i) %\method{[}{OutputsModel}(x, i)
} }
...@@ -29,6 +29,8 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD) ...@@ -29,6 +29,8 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD)
\item{Param}{[numeric] vector of model parameters (See details for SD lag model)} \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{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} %\item{x}{[InputsModel] object of class InputsModel}
% %
......
Supports Markdown
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