diff --git a/R/RunModel.GRiwrmInputsModel.R b/R/RunModel.GRiwrmInputsModel.R index 01d7f3db0e1f971c7a7ed35567824ec7d0cbb1b7..12ce0f73d872c532e7d09429ca4d7da59120d9b2 100644 --- a/R/RunModel.GRiwrmInputsModel.R +++ b/R/RunModel.GRiwrmInputsModel.R @@ -5,7 +5,7 @@ #' @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 [[list] of class \emph{GRiwrmOutputsModel}] list of \emph{OutputsModel} objects (See \[airGR::RunModel]) for each node of the semi-distributed model +#' @return A 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. #' @export #' @examples #' ################################################################### diff --git a/R/RunModel.InputsModel.R b/R/RunModel.InputsModel.R index 7ed3906f6d6669995541a629b1c4e43f8389b23b..d64876a9886cc1fbbf754ac2c87f9ea1fa89c508 100644 --- a/R/RunModel.InputsModel.R +++ b/R/RunModel.InputsModel.R @@ -1,9 +1,15 @@ #' 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. +#' #' @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 +#' #' @export RunModel.InputsModel <- function(x, RunOptions, Param, FUN_MOD = NULL, ...) { if(is.null(FUN_MOD)) { diff --git a/R/UpdateQsimUpstream.R b/R/UpdateQsimUpstream.R index 6fd986b58376afc6f0753368a0eb5282085bb0f9..3afa52d8c94c02ddb7b716077973866eb1d404a6 100644 --- a/R/UpdateQsimUpstream.R +++ b/R/UpdateQsimUpstream.R @@ -7,7 +7,7 @@ #' @description This function is used by [RunModel.GRiwrmInputsModel] and [Calibration.GRiwrmInputsModel] #' in order to provide upstream simulated flows to a node. #' -#' @return `InputsModel` object with updated `Qupstream` +#' @return `InputsModel` object with updated `Qupstream` (See [airGR::CreateInputsModel] for the detail of the object). #' @noRd #' UpdateQsimUpstream <- function(InputsModel, Runoptions, OutputsModel) { diff --git a/R/plot.GRiwrm.R b/R/plot.GRiwrm.R index 8a6aaa2c5af78ae81a7129cef7fa3471b76e0815..a35a4226e7871db438bb9b56614730ec300e70e2 100644 --- a/R/plot.GRiwrm.R +++ b/R/plot.GRiwrm.R @@ -10,7 +10,7 @@ #' @details This function only works inside RStudio because the HTMLwidget produced by DiagrammeR #' is not handled on some platforms #' -#' @return Mermaid code of the diagram if display is `FALSE`. +#' @return Mermaid code of the diagram if display is `FALSE`, otherwise the function returns the diagram itself. #' #' @export #' diff --git a/R/plot.GRiwrmOutputsModel.R b/R/plot.GRiwrmOutputsModel.R index 8175300cd34f592213c04abe2295aa96566d69e2..cbd0345590550beb9a14744c5d818dbc7b7d7933 100644 --- a/R/plot.GRiwrmOutputsModel.R +++ b/R/plot.GRiwrmOutputsModel.R @@ -6,7 +6,7 @@ #' by hydrological model output named with the node ID (See [CreateGRiwrm] for details) #' @param ... Further arguments for [airGR::plot.OutputsModel] and [plot] #' -#' @return [list] of plots +#' @return [list] of plots. #' #' @importFrom graphics plot par title #' @export diff --git a/R/plot.Qm3s.R b/R/plot.Qm3s.R index aa406279019e823da62fb3cef9d32ca972649a29..feb05ae09b4017b339dd1d0fc14ca2c1289aed39 100644 --- a/R/plot.Qm3s.R +++ b/R/plot.Qm3s.R @@ -11,6 +11,8 @@ #' @param lty [character] or [numeric] The line type (See [par]) #' @param ... Further arguments to pass to the [matplot] functions #' +#' @return Screen plot window. +#' #' @importFrom grDevices rainbow #' @importFrom graphics matplot #' @export diff --git a/man/RunModel.GRiwrmInputsModel.Rd b/man/RunModel.GRiwrmInputsModel.Rd index 629450e1b40c56b12913152d3bb197c64553951f..07a34b47daab8b364fd363f37a0d7a2b0462efa9 100644 --- a/man/RunModel.GRiwrmInputsModel.Rd +++ b/man/RunModel.GRiwrmInputsModel.Rd @@ -16,7 +16,7 @@ \item{...}{Further arguments for compatibility with S3 methods} } \value{ -[\link{list} of class \emph{GRiwrmOutputsModel}] list of \emph{OutputsModel} objects (See [airGR::RunModel]) for each node of the semi-distributed model +A object of class \emph{GRiwrmOutputsModel}. This object is a \link{list} of \emph{OutputsModel} objects produced by \link{RunModel.InputsModel} for each node of the semi-distributed model. } \description{ RunModel function for \emph{GRiwrmInputsModel} object diff --git a/man/RunModel.InputsModel.Rd b/man/RunModel.InputsModel.Rd index a1cf143cd816176004e261fe4ce145031a177b6c..7f9e11c71343aae58f065f2feeeb6db7055c0ee8 100644 --- a/man/RunModel.InputsModel.Rd +++ b/man/RunModel.InputsModel.Rd @@ -17,6 +17,16 @@ \item{...}{Further arguments for compatibility with S3 methods} } +\value{ +[list] see \code{\link[airGR]{RunModel_GR4J}} or \code{\link[airGR]{RunModel_CemaNeigeGR4J}} for details. + +If \code{InputsModel} parameter has been created for using a semi-distributed (SD) lag model (See \code{\link[airGR]{CreateInputsModel}}), the list value contains an extra item named \code{QsimDown} which is a numeric series of simulated discharge [mm/time step] related to the run-off contribution of the downstream sub-catchment. +} \description{ Wrapper for \link[airGR:RunModel]{airGR::RunModel} for one sub-basin } +\details{ +This function calls \link[airGR:RunModel]{airGR::RunModel} (See \link[airGR:RunModel]{airGR::RunModel} for further details). + +The list produced by the function (See Value section of \link[airGR:RunModel_GR4J]{airGR::RunModel_GR4J}) is here completed by an item \emph{$Qsim_m3} storing the simulated discharge series in m3/s. +} diff --git a/man/plot.GRiwrm.Rd b/man/plot.GRiwrm.Rd index 98744d74461971bba27352d6ecd5b96015323466..d34e84696761155869750f00febc569b4f8ba8fe 100644 --- a/man/plot.GRiwrm.Rd +++ b/man/plot.GRiwrm.Rd @@ -27,7 +27,7 @@ \item{...}{Other arguments and parameters you would like to send to JavaScript (See \link[DiagrammeR:mermaid]{DiagrammeR::mermaid})} } \value{ -Mermaid code of the diagram if display is \code{FALSE}. +Mermaid code of the diagram if display is \code{FALSE}, otherwise the function returns the diagram itself. } \description{ Display of a diagram representing the network structure of a GRiwrm object diff --git a/man/plot.GRiwrmOutputsModel.Rd b/man/plot.GRiwrmOutputsModel.Rd index 42a99bfaf20d94832feb7b33216428be06d7880c..f25a416c29c271b075685bf13ed5fd8e7a6b024e 100644 --- a/man/plot.GRiwrmOutputsModel.Rd +++ b/man/plot.GRiwrmOutputsModel.Rd @@ -16,7 +16,7 @@ by hydrological model output named with the node ID (See \link{CreateGRiwrm} for \item{...}{Further arguments for \link[airGR:plot.OutputsModel]{airGR::plot.OutputsModel} and \link{plot}} } \value{ -\link{list} of plots +\link{list} of plots. } \description{ Function which creates screen plots giving an overview of the model outputs in the GRiwrm network diff --git a/man/plot.Qm3s.Rd b/man/plot.Qm3s.Rd index 4b84eb35ce1fae07340522a82c9948b9ef9c8c81..e09586eb03c415240be35e938deab7c41f1ecebe 100644 --- a/man/plot.Qm3s.Rd +++ b/man/plot.Qm3s.Rd @@ -38,6 +38,9 @@ \item{...}{Further arguments to pass to the \link{matplot} functions} } +\value{ +Screen plot window. +} \description{ Plot of a \code{Qm3s} object (time series of simulated flows) }