docs: update param x and correct mispell

R/Calibration.R

@@ -18,7 +18,7 @@
 #'
 #' @return Depending on the class of `InputsModel` argument (respectively `InputsModel` and `GRiwrmInputsModel` object), the returned value is respectively:
 #' - a `InputsCrit` object (See [airGR::CreateInputsCrit])
-#' - a `GRiwrmInputsCrit` object which is a [list] of `InputsCrit` object with one item per modelled sub-catchment
+#' - a `GRiwrmInputsCrit` object which is a [list] of `InputsCrit` objects with one item per modelled sub-catchment
 #'
 #' @rdname Calibration
 #' @export

R/CreateInputsCrit.R

@@ -23,7 +23,7 @@
 #'
 #' @return Depending on the class of `InputsModel` argument (respectively `InputsModel` and `GRiwrmInputsModel` object), the returned value is respectively:
 #' - a `InputsCrit` object (See [airGR::CreateInputsCrit])
-#' - a `GRiwrmInputsCrit` object which is a [list] of `InputsCrit` object with one item per modelled sub-catchment
+#' - a `GRiwrmInputsCrit` object which is a [list] of `InputsCrit` objects with one item per modelled sub-catchment
 #'
 #' @references De Lavenne, A., Andréassian, V., Thirel, G., Ramos, M.-H., Perrin, C., 2019. A Regularization Approach to Improve the Sequential Calibration of a Semidistributed Hydrological Model. Water Resources Research 55, 8821–8839. \doi{10.1029/2018WR024266}
 #'

R/CreateRunOptions.R

-#' Creation of the CalibOptions object
+#' Creation of the RunOptions object
 #'
 #' This function can be used either for a catchment (with an \emph{InputsModel} object) or for a network (with a \emph{GRiwrmInputsModel} object)
 #'
@@ -13,7 +13,7 @@
 #'
 #' @return Depending on the class of `InputsModel` argument (respectively \emph{InputsModel} and \emph{GRiwrmInputsModel} object), the returned value is respectively:
 #' - a `RunOptions` object (See [airGR::CreateRunOptions])
-#' - a `GRiwrmRunOptions` object which is a [list] of `RunOptions` object with one item per modelled sub-catchment
+#' - a `GRiwrmRunOptions` object which is a [list] of `RunOptions` objects with one item per modelled sub-catchment
 #'
 #' @rdname CreateRunOptions
 #' @export

man-roxygen/param_x.R

-#' @param x [function], [character], or object of class \emph{InputsModel} runs [airGR::CreateRunOptions]for a catchment. Use object of class \emph{GRiwrmInputsModel} for a network. See [CreateInputsModel] for details
+#' @param x For a single catchment, it can be an object of class \emph{InputsModel} or a [function] or a [character] corresponding to `FUN_MOD` (compliant with **airGR** call). For a network, it should be an object of class \emph{GRiwrmInputsModel}. See [CreateInputsModel] for details
 #'

man/Calibration.Rd

@@ -37,7 +37,7 @@ Calibration(InputsModel, ...)
 Depending on the class of \code{InputsModel} argument (respectively \code{InputsModel} and \code{GRiwrmInputsModel} object), the returned value is respectively:
 \itemize{
 \item a \code{InputsCrit} object (See \link[airGR:CreateInputsCrit]{airGR::CreateInputsCrit})
-\item a \code{GRiwrmInputsCrit} object which is a \link{list} of \code{InputsCrit} object with one item per modelled sub-catchment
+\item a \code{GRiwrmInputsCrit} object which is a \link{list} of \code{InputsCrit} objects with one item per modelled sub-catchment
 }
 }
 \description{

man/CreateCalibOptions.Rd

@@ -20,7 +20,7 @@ CreateCalibOptions(x, ...)
 \method{CreateCalibOptions}{`function`}(x, ...)
 }
 \arguments{
-\item{x}{\link{function}, \link{character}, or object of class \emph{InputsModel} runs \link[airGR:CreateRunOptions]{airGR::CreateRunOptions}for a catchment. Use object of class \emph{GRiwrmInputsModel} for a network. See \link{CreateInputsModel} for details}
+\item{x}{For a single catchment, it can be an object of class \emph{InputsModel} or a \link{function} or a \link{character} corresponding to \code{FUN_MOD} (compliant with \strong{airGR} call). For a network, it should be an object of class \emph{GRiwrmInputsModel}. See \link{CreateInputsModel} for details}
 
 \item{...}{arguments passed to \link[airGR:CreateCalibOptions]{airGR::CreateCalibOptions}, see details}
 }

man/CreateInputsCrit.Rd

@@ -43,7 +43,7 @@ CreateInputsCrit(InputsModel, ...)
 Depending on the class of \code{InputsModel} argument (respectively \code{InputsModel} and \code{GRiwrmInputsModel} object), the returned value is respectively:
 \itemize{
 \item a \code{InputsCrit} object (See \link[airGR:CreateInputsCrit]{airGR::CreateInputsCrit})
-\item a \code{GRiwrmInputsCrit} object which is a \link{list} of \code{InputsCrit} object with one item per modelled sub-catchment
+\item a \code{GRiwrmInputsCrit} object which is a \link{list} of \code{InputsCrit} objects with one item per modelled sub-catchment
 }
 }
 \description{

man/CreateRunOptions.Rd

@@ -7,7 +7,7 @@
 \alias{CreateRunOptions.InputsModel}
 \alias{CreateRunOptions.character}
 \alias{CreateRunOptions.function}
-\title{Creation of the CalibOptions object}
+\title{Creation of the RunOptions object}
 \usage{
 \method{CreateRunOptions}{GRiwrmInputsModel}(x, IniStates = NULL, ...)
 
@@ -20,7 +20,7 @@ CreateRunOptions(x, ...)
 \method{CreateRunOptions}{`function`}(x, ...)
 }
 \arguments{
-\item{x}{\link{function}, \link{character}, or object of class \emph{InputsModel} runs \link[airGR:CreateRunOptions]{airGR::CreateRunOptions}for a catchment. Use object of class \emph{GRiwrmInputsModel} for a network. See \link{CreateInputsModel} for details}
+\item{x}{For a single catchment, it can be an object of class \emph{InputsModel} or a \link{function} or a \link{character} corresponding to \code{FUN_MOD} (compliant with \strong{airGR} call). For a network, it should be an object of class \emph{GRiwrmInputsModel}. See \link{CreateInputsModel} for details}
 
 \item{IniStates}{(optional) \link{numeric} object or \link{list} of \link{numeric} object of class \emph{IniStates}, see \link[airGR:CreateIniStates]{airGR::CreateIniStates} for details}
 
@@ -30,7 +30,7 @@ CreateRunOptions(x, ...)
 Depending on the class of \code{InputsModel} argument (respectively \emph{InputsModel} and \emph{GRiwrmInputsModel} object), the returned value is respectively:
 \itemize{
 \item a \code{RunOptions} object (See \link[airGR:CreateRunOptions]{airGR::CreateRunOptions})
-\item a \code{GRiwrmRunOptions} object which is a \link{list} of \code{RunOptions} object with one item per modelled sub-catchment
+\item a \code{GRiwrmRunOptions} object which is a \link{list} of \code{RunOptions} objects with one item per modelled sub-catchment
 }
 }
 \description{