docs(RunModel): various improvements

Closes #133

R/RunModel.GRiwrmInputsModel.R

@@ -5,7 +5,16 @@
 #' @param Param [list] parameter values. The list item names are the IDs of the sub-basins. Each item is a [numeric] [vector]
 #' @param ... Further arguments for compatibility with S3 methods
 #'
-#' @return An object of class \emph{GRiwrmOutputsModel}. This object is a [list] of *OutputsModel* objects produced by [RunModel.InputsModel] for each node of the semi-distributed model.
+#' @return An object of class \emph{GRiwrmOutputsModel}.
+#' This object is a [list] of *OutputsModel* objects produced by [RunModel.InputsModel]
+#' for each node of the semi-distributed model.
+#'
+#' It also contains the following attributes (see [attr]):
+#' - "Qm3s": a [data.frame] containing the dates of simulation and one column by node
+#' with the simulated flows in cubic meters per seconds (See [plot.Qm3s])
+#' - "GRiwrm":  a copy of the *GRiwrm* object produced by [CreateGRiwrm] and used for the simulation
+#' - "TimeStep":  time step of the simulation in seconds
+#'
 #' @export
 #' @seealso [CreateGRiwrm()], [CreateInputsModel.GRiwrm()], [CreateRunOptions()]
 #' @example man-examples/RunModel.GRiwrmInputsModel.R

R/RunModel.InputsModel.R

@@ -1,21 +1,20 @@
 #' Wrapper for [airGR::RunModel] for one sub-basin
 #'
-#' @details This function calls [airGR::RunModel] (See [airGR::RunModel] for further details).
-#'
-#' The list produced by the function (See Value section of [airGR::RunModel_GR4J])
-#' is here completed by:
-#'
-#' - an item `$Qsim_m3` storing the simulated discharge series in m3/s
-#' - an item `$Qover_m3` storing the volumes of over abstraction which occurs
-#' when `RunModel_Lag` warns for negative simulated flows. The latter reflects the volume
-#' that was planned to be drawn from the sub-basin but could not be drawn because
-#' of the lack of water.
-#'
 #' @inheritParams airGR::RunModel
 #' @param x \[object of class \emph{InputsModel}\] see [airGR::CreateInputsModel] for details
 #' @param ... Further arguments for compatibility with S3 methods
 #'
-#' @inherit airGR::RunModel return return
+#' @returns \[object of class \emph{OutputsModel}\] returned by [airGR::RunModel]
+#' (See Value section of [airGR::RunModel_GR4J]) completed by new items:
+#' - `Qsim_m3`: simulated flow in cubic meters per time step
+#' - `Qover_m3` volumes of over abstractions which occurs when `RunModel_Lag` warns
+#' for negative simulated flows
+#' - `Qnat`: only present in case of Diversion in the node, simulated flow in mm
+#' per time step before application of the Diversion
+#' - `Qdiv_m3`: only present in case of Diversion in the node, simulated diverted flow in
+#' cubic meters per time step. The latter differs from the flows time series provided
+#' in argument `Qinf` of [CreateInputsModel.GRiwrm] by the limitation of diversion
+#' applied by the minimum flow threshold `Qmin` to keep flowing in the river
 #'
 #' @export
 RunModel.InputsModel <- function(x = NULL,

R/RunModel_Reservoir.R

@@ -40,7 +40,16 @@
 #' of the reservoir and (2) the celerity in m/s of the upstream inflows.
 #'
 #' @return An *OutputsModel* object like the one return by [airGR::RunModel] but
-#' completed with an item `Vsim` representing the water volume time series in m3.
+#' completed with the items:
+#' - `Vsim`: representing the water volume time series in m3
+#' - `Qsim_m3`: flow released by the reservoir in cubic meters by time step
+#' (see Details)
+#' - `Qdiv_m3`: only present in case of Diversion in the node, diverted flow in
+#' cubic meters per time step. The latter differs from the flows time series provided
+#' in argument `Qinf` of [CreateInputsModel.GRiwrm] by the limitation due to an
+#' empty reservoir
+#' - `Qover_m3`: only present in case of Diversion in the node, diverted volumes
+#' that cannot be operated due to an empty reservoir
 #' @export
 #'
 #' @example man-examples/RunModel_Reservoir.R