Commit 19137364 authored by Dorchies David's avatar Dorchies David
Browse files

doc: mispell Griwrm in documentation

Refs #43
parent 0e81e771
Pipeline #24831 failed with stages
in 5 minutes and 40 seconds
......@@ -21,7 +21,7 @@
Calibration(InputsModel, ...)
}
\arguments{
\item{InputsModel}{[object of class \emph{InputsModel} or \emph{GRwirmInputsModel}] see \link{CreateInputsModel}}
\item{InputsModel}{[object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}] see \link{CreateInputsModel}}
\item{RunOptions}{[object of class \emph{RunOptions} or \emph{GRiwrmRunOptions}] see \link{CreateRunOptions}}
......
......@@ -14,7 +14,7 @@
CreateCalibOptions(InputsModel, ...)
}
\arguments{
\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRwirmInputsModel}. See \link{CreateInputsModel} for details}
\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}. See \link{CreateInputsModel} for details}
\item{...}{arguments passed to \link[airGR:CreateCalibOptions]{airGR::CreateCalibOptions}, see details}
}
......@@ -31,5 +31,5 @@ This function can be used either for a catchment (with an \emph{InputsModel} obj
\details{
See \link[airGR:CreateCalibOptions]{airGR::CreateCalibOptions} documentation for a complete list of arguments.
With a \emph{GRwirmInputsModel} object, all arguments are applied on each sub-catchments of the network.
With a \emph{GRiwrmInputsModel} object, all arguments are applied on each sub-catchments of the network.
}
......@@ -20,7 +20,7 @@
CreateInputsCrit(InputsModel, ...)
}
\arguments{
\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRwirmInputsModel}. See \link{CreateInputsModel}}
\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}. See \link{CreateInputsModel}}
\item{FUN_CRIT}{[function (atomic or list)] error criterion function (e.g. \link[airGR:ErrorCrit_RMSE]{airGR::ErrorCrit_RMSE}, \link[airGR:ErrorCrit_NSE]{airGR::ErrorCrit_NSE})}
......@@ -45,5 +45,5 @@ See \link[airGR:CreateInputsCrit]{airGR::CreateInputsCrit} documentation for a c
\code{Obs} argument is equivalent to the same argument in \link[airGR:CreateInputsCrit]{airGR::CreateInputsCrit} except that it must a \link{matrix} or a \link{data.frame} if \code{InputsModel} is a \emph{GRiwrmInputsModel} object. Then, each column of the \link{matrix} or \link{data.frame} represents the observations of one of the simulated node with the name of the columns representing the id of each node.
With a \emph{GRwirmInputsModel} object, all arguments are applied on each sub-catchments of the network.
With a \emph{GRiwrmInputsModel} object, all arguments are applied on each sub-catchments of the network.
}
......@@ -14,7 +14,7 @@
CreateRunOptions(InputsModel, ...)
}
\arguments{
\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRwirmInputsModel}. See \link{CreateInputsModel} for details}
\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}. See \link{CreateInputsModel} for details}
\item{...}{arguments passed to \link[airGR:CreateRunOptions]{airGR::CreateRunOptions}, see details}
}
......@@ -31,7 +31,7 @@ This function can be used either for a catchment (with an \emph{InputsModel} obj
\details{
See \link[airGR:CreateRunOptions]{airGR::CreateRunOptions} documentation for a complete list of arguments.
With a \emph{GRwirmInputsModel} object, all arguments are applied on each sub-catchments of the network.
With a \emph{GRiwrmInputsModel} object, all arguments are applied on each sub-catchments of the network.
}
\examples{
#################################################################
......
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