From 74a0c719da4acae9a9f2426fcc614eca5ad6ced1 Mon Sep 17 00:00:00 2001
From: Dorchies David <david.dorchies@irstea.fr>
Date: Thu, 11 Jun 2020 15:00:42 +0200
Subject: [PATCH] doc: simplify airGR wrappers documentation

---
 R/Calibration.InputsModel.R        | 7 ++-----
 R/CreateCalibOptions.InputsModel.R | 7 ++-----
 R/CreateInputsCrit.InputsModel.R   | 8 ++------
 R/CreateInputsModel.default.R      | 9 ++-------
 R/CreateRunOptions.InputsModel.R   | 7 ++-----
 R/RunModel.InputsModel.R           | 9 ++-------
 6 files changed, 12 insertions(+), 35 deletions(-)

diff --git a/R/Calibration.InputsModel.R b/R/Calibration.InputsModel.R
index 6520ab8..1eab94b 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 b8fc8a6..f31e3c4 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 f1a337b..b4780ef 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 3b3e5ba..e2ba817 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 ef69791..5ec1991 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 3b94045..c4d2287 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)) {
-- 
GitLab