diff --git a/R/Calibration.InputsModel.R b/R/Calibration.InputsModel.R index 6520ab81cf8716f89c4cba8f85841b8ff680e188..1eab94bd1da6c32d0f80c527f157686827088ccd 100644 --- a/R/Calibration.InputsModel.R +++ b/R/Calibration.InputsModel.R @@ -1,9 +1,6 @@ -#' Wrapper to \code{\link[airGR]{Calibration}}. +#' Wrapper to \code{\link[airGR]{Calibration}} for one sub-basin. #' -#' @param InputsModel object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. -#' @param ... further arguments passed to \code{\link[airGR]{Calibration}}. -#' -#' @return \emph{CalibOutput} object. +#' @inherit airGR::Calibration #' @export Calibration.InputsModel <- function(InputsModel, ...) { airGR::Calibration(InputsModel, FUN_MOD = InputsModel$FUN_MOD, ...) diff --git a/R/CreateCalibOptions.InputsModel.R b/R/CreateCalibOptions.InputsModel.R index b8fc8a6b64332edc50a4c79328204e178920b2e0..f31e3c439169ae412427b9764710959459d12a9a 100644 --- a/R/CreateCalibOptions.InputsModel.R +++ b/R/CreateCalibOptions.InputsModel.R @@ -1,9 +1,6 @@ -#' Wrapper to \code{\link[airGR]{CreateCalibOptions}} +#' Wrapper to \code{\link[airGR]{CreateCalibOptions}} for one sub-basin. #' -#' @param InputsModel object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. -#' @param ... further arguments passed to \code{\link[airGR]{CreateCalibOptions}}. -#' -#' @return \emph{CalibOptions} object. +#' @inherit airGR::CreateCalibOptions #' @export CreateCalibOptions.InputsModel <- function(InputsModel, ...) { diff --git a/R/CreateInputsCrit.InputsModel.R b/R/CreateInputsCrit.InputsModel.R index f1a337bd590af5facae220e6f70861badd5664d4..b4780ef0716b910b788071bedafb30bf46bdd6bc 100644 --- a/R/CreateInputsCrit.InputsModel.R +++ b/R/CreateInputsCrit.InputsModel.R @@ -1,10 +1,6 @@ -#' Wrapper to \code{\link[airGR]{CreateInputsCrit}} +#' Wrapper to \code{\link[airGR]{CreateInputsCrit}} for one sub-basin. #' -#' @param InputsModel object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. -#' @param FUN_CRIT \[function (atomic or list)\] error criterion function (e.g. \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}) -#' @param ... further arguments passed to \code{\link[airGR]{CreateInputsCrit}} -#' -#' @return object of class \emph{InputsCrit} containing the data required to evaluate the model outputs. See \code{\link[airGR]{CreateInputsCrit}} +#' @inherit airGR::CreateInputsCrit #' @export CreateInputsCrit.InputsModel <- function(InputsModel, FUN_CRIT, diff --git a/R/CreateInputsModel.default.R b/R/CreateInputsModel.default.R index 3b3e5bab1c9ac8f57576a50b8c09d45b261624e0..e2ba8175de897c3c638d069fd6c7600e24a9d505 100644 --- a/R/CreateInputsModel.default.R +++ b/R/CreateInputsModel.default.R @@ -1,12 +1,7 @@ -#' Wrapper for the airGR::CreateInputsModel function +#' Wrapper for \code{\link[airGR]{CreateInputsModel}} for one sub-basin. #' -#' @param x hydrological model function (e.g. \code{\link[airGR]{RunModel_GR4J}}, \code{\link[airGR]{RunModel_CemaNeigeGR4J}}) -#' @param ... further arguments passed to \code{\link[airGR]{CreateInputsModel}}. -#' -#' @return object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. -#' @import airGR +#' @inherit airGR::CreateInputsModel #' @export -#' @seealso The original function in airGR package: \code{\link[airGR]{CreateInputsModel}}. #' CreateInputsModel.default <- function(x, ...) { diff --git a/R/CreateRunOptions.InputsModel.R b/R/CreateRunOptions.InputsModel.R index ef6979194d59f0ded0589e2c4b3d2b55f00a2891..5ec199179131c0f7db963c02dfbcd36609273608 100644 --- a/R/CreateRunOptions.InputsModel.R +++ b/R/CreateRunOptions.InputsModel.R @@ -1,9 +1,6 @@ -#' Create \emph{RunOptions} object for airGR. See \code{\link[airGR]{CreateOptions}}. +#' Wrapper for \code{\link[airGR]{CreateRunOptions}} for one sub-basin. #' -#' @param InputsModel object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. -#' @param ... further arguments passed to \code{\link[airGR]{CreateOptions}}. -#' -#' @return See \code{\link[airGR]{CreateOptions}}. +#' @inherit airGR::CreateRunOptions #' @export CreateRunOptions.InputsModel <- function(InputsModel, ...) { diff --git a/R/RunModel.InputsModel.R b/R/RunModel.InputsModel.R index 3b94045a3c66301260ec283d35909774804f208a..c4d2287bf07be41ce11f9db6032e5f8b4410f2b8 100644 --- a/R/RunModel.InputsModel.R +++ b/R/RunModel.InputsModel.R @@ -1,11 +1,6 @@ -#' Wrapper for \code{\link[airGR]{RunModel}} which performs a single model run with the provided function over the selected period. +#' Wrapper for \code{\link[airGR]{RunModel}} for one sub-basin. #' -#' @param InputsModel object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. -#' @param RunOptions object of class \emph{RunOptions}, see \code{\link[airGR]{CreateRunOptions}} for details. -#' @param Param numeric vector of model parameters. -#' @param FUN_MOD hydrological model function (e.g. \code{\link[airGR]{RunModel_GR4J}}, \code{\link[airGR]{RunModel_CemaNeigeGR4J}}). -#' -#' @return +#' @inherit airGR::RunModel #' @export RunModel.InputsModel <- function(InputsModel, RunOptions, Param, FUN_MOD = NULL, ...) { if(is.null(FUN_MOD)) {