diff --git a/R/Calibration.GRiwrmInputsModel.R b/R/Calibration.GRiwrmInputsModel.R index 3b62b7761caa3166ec8000ece5591de648991702..1e99049418c12085cada77ee9b49a861bfe42fc1 100644 --- a/R/Calibration.GRiwrmInputsModel.R +++ b/R/Calibration.GRiwrmInputsModel.R @@ -1,13 +1,13 @@ #' Calibration of a semi-distributed run-off model #' -#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. -#' @param RunOptions object of class \emph{GRiwrmRunOptions}, see \code{\link{CreateRunOptions.GRiwrmInputsModel}} for details. -#' @param InputsCrit object of class \emph{GRiwrmInputsCrit}, see \code{\link{CreateInputsCrit.GRiwrmInputsModel}} for details. -#' @param CalibOptions object of class \emph{GRiwrmCalibOptions}, see \code{\link{CreateCalibOptions.GRiwrmInputsModel}} for details. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see [CreateInputsModel.GRiwrm] for details. +#' @param RunOptions object of class \emph{GRiwrmRunOptions}, see [CreateRunOptions.GRiwrmInputsModel] for details. +#' @param InputsCrit object of class \emph{GRiwrmInputsCrit}, see [CreateInputsCrit.GRiwrmInputsModel] for details. +#' @param CalibOptions object of class \emph{GRiwrmCalibOptions}, see [CreateCalibOptions.GRiwrmInputsModel] for details. #' @param useUpstreamQsim boolean describing if simulated (\code{TRUE}) or observed (\code{FALSE}) flows are used for calibration. Default is \code{TRUE}. -#' @param ... further arguments passed to \code{\link[airGR]{Calibration}}. +#' @param ... further arguments passed to [airGR::Calibration]. #' -#' @return GRiwrmOutputsCalib object which is a list of OutputsCalib (See \code{\link[airGR]{Calibration}}) for each node of the semi-distributed model. +#' @return GRiwrmOutputsCalib object which is a list of OutputsCalib (See [airGR::Calibration]) for each node of the semi-distributed model. #' @export Calibration.GRiwrmInputsModel <- function(InputsModel, RunOptions, diff --git a/R/Calibration.InputsModel.R b/R/Calibration.InputsModel.R index 3eaaebc2e4ee77b63dcdcb736bcc0a266e328591..8f0d9dbbc43a689bd358dc43fb4671ef3aeae5e6 100644 --- a/R/Calibration.InputsModel.R +++ b/R/Calibration.InputsModel.R @@ -1,4 +1,4 @@ -#' Wrapper to \code{\link[airGR]{Calibration}} for one sub-basin. +#' Wrapper to [airGR::Calibration] for one sub-basin. #' #' @inherit airGR::Calibration #' @param ... Further arguments for compatibility with S3 method diff --git a/R/CreateCalibOptions.GRiwrmInputsModel.R b/R/CreateCalibOptions.GRiwrmInputsModel.R index 3c0d16809be92e2b01f47d36e8662103c849073f..f9ba5295d228cb43ef836016e4615edbda8ba3ad 100644 --- a/R/CreateCalibOptions.GRiwrmInputsModel.R +++ b/R/CreateCalibOptions.GRiwrmInputsModel.R @@ -1,7 +1,7 @@ #' Title #' -#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. -#' @param ... further arguments passed to \code{\link[airGR]{CreateCalibOptions}}. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see [CreateInputsModel.GRiwrm] for details. +#' @param ... further arguments passed to [airGR::CreateCalibOptions]. #' #' @return \emph{GRiwrmCalibOptions} object. #' @export diff --git a/R/CreateCalibOptions.InputsModel.R b/R/CreateCalibOptions.InputsModel.R index 1c4c0d1a5cc559c76f018b0c754febc24cda0c9a..95e6bdee2ae9757b192caf504c5c84afc1a5270e 100644 --- a/R/CreateCalibOptions.InputsModel.R +++ b/R/CreateCalibOptions.InputsModel.R @@ -1,7 +1,7 @@ -#' Wrapper to \code{\link[airGR]{CreateCalibOptions}} for one sub-basin. +#' Wrapper to [airGR::CreateCalibOptions] for one sub-basin. #' -#' @param InputsModel object of class \emph{InputsModel}. See \code{\link[airGR]{CreateInputsModel}} for details -#' @param ... Arguments passed to \code{\link[airGR]{CreateCalibOptions}} +#' @param InputsModel object of class \emph{InputsModel}. See [airGR::CreateInputsModel] for details +#' @param ... Arguments passed to [airGR::CreateCalibOptions] #' @export CreateCalibOptions.InputsModel <- function(InputsModel, ...) { diff --git a/R/CreateCalibOptions.R b/R/CreateCalibOptions.R index 6b464b7123e01dba9e695d810fc723e111ab8e90..e1800ca76a64979ff2e09ed4ea6993e202c36916 100644 --- a/R/CreateCalibOptions.R +++ b/R/CreateCalibOptions.R @@ -1,6 +1,6 @@ #' CreateCalibOptions both available for \emph{InputsModel} and \emph{GRwirmInputsModel} objects #' -#' @param InputsModel object of class \emph{InputsModel} or \emph{GRwirmInputsModel}. See \code{\link{CreateInputsModel}} for details +#' @param InputsModel object of class \emph{InputsModel} or \emph{GRwirmInputsModel}. See [CreateInputsModel] for details #' @param ... further arguments passed to or from other methods #' #' @return Either a `CalibOptions` or a `GRiwrmCalibOptions` object diff --git a/R/CreateInputsCrit.GRiwrmInputsModel.R b/R/CreateInputsCrit.GRiwrmInputsModel.R index 889600818f88276667a706f849023ef5b7f5fd4e..bd6a7f0bd0cfff3c44e4fd0b69a511556cd8c115 100644 --- a/R/CreateInputsCrit.GRiwrmInputsModel.R +++ b/R/CreateInputsCrit.GRiwrmInputsModel.R @@ -2,9 +2,9 @@ #' #' This function does the same operations as [airGR::CreateInputsCrit] for all sub-basins of the GRiwrm model. #' -#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} 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 RunOptions object of class \emph{GRiwrmRunOptions}, see \code{[CreateRunOptions.GRiwrm]} for details. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see [CreateInputsModel.GRiwrm] for details. +#' @param FUN_CRIT \[function (atomic or list)\] error criterion function (e.g. [airGR::ErrorCrit_RMSE], [airGR::ErrorCrit_NSE]) +#' @param RunOptions object of class \emph{GRiwrmRunOptions}, see [CreateRunOptions.GRiwrm] for details. #' @param Qobs matrix or data frame containing observed flows. Column names correspond to nodes ID #' @param ... further arguments passed to [airGR::CreateInputsCrit]. #' diff --git a/R/CreateInputsCrit.InputsModel.R b/R/CreateInputsCrit.InputsModel.R index e3341e9fcb062a66bde46ac428628af8414a4485..bc9d0b174ffef6e9c8a271ea04da22ccd79c30f1 100644 --- a/R/CreateInputsCrit.InputsModel.R +++ b/R/CreateInputsCrit.InputsModel.R @@ -1,4 +1,4 @@ -#' Wrapper to \code{\link[airGR]{CreateInputsCrit}} for one sub-basin. +#' Wrapper to [airGR::CreateInputsCrit] for one sub-basin. #' #' @inherit airGR::CreateInputsCrit #' @param ... Further arguments for compatibility with S3 method diff --git a/R/CreateInputsCrit.R b/R/CreateInputsCrit.R index d6e092c37615bef651e2228b92bcb3b73bcd94d5..70846656d165a9972465e3bfea103d3ea2dddcb4 100644 --- a/R/CreateInputsCrit.R +++ b/R/CreateInputsCrit.R @@ -1,6 +1,6 @@ #' Creation of the InputsCrit object required to the ErrorCrit functions #' -#' @param InputsModel InputsModel for **airGRiwrm** (See \code{[CreateInputsModel.GRiwrm]}) or **airGR** (See \code{\link[airGR]{CreateInputsModel}}) +#' @param InputsModel InputsModel for **airGRiwrm** (See \code{[CreateInputsModel.GRiwrmInputsModel]}) or **airGR** (See [airGR::CreateInputsModel]) #' @param ... further arguments passed to or from other methods. #' #' @return Either a `InputsCrit` or a `GRiwrmInputsCrit` object diff --git a/R/CreateInputsModel.GRiwrm.R b/R/CreateInputsModel.GRiwrm.R index dcdd44188a4521ed16dde9a3a20d2e42b4ce340a..d05870c588e79e49e2567f8a2e688aa9c70b38fe 100644 --- a/R/CreateInputsModel.GRiwrm.R +++ b/R/CreateInputsModel.GRiwrm.R @@ -5,9 +5,9 @@ #' @param Precip Matrix or data frame of numeric containing precipitation in mm. Column names correspond to node IDs. #' @param PotEvap Matrix or data frame of numeric containing potential evaporation in mm. Column names correspond to node IDs. #' @param Qobs Matrix or data frame of numeric containing potential observed flow in mm. Column names correspond to node IDs. -#' @param ... further arguments passed to \code{\link[airGR]{CreateInputsModel}}. +#' @param ... further arguments passed to [airGR::CreateInputsModel]. #' -#' @return GRiwrmInputsModel object equivalent to **airGR** InputsModel object for a semi-distributed model (See \code{\link[airGR]{CreateInputsModel}}) +#' @return GRiwrmInputsModel object equivalent to **airGR** InputsModel object for a semi-distributed model (See [airGR::CreateInputsModel]) #' @export #' @examples #' ################################################################# diff --git a/R/CreateInputsModel.default.R b/R/CreateInputsModel.default.R index a03019315f9b90f0bc5696c7fbe631ad8ad3fcee..602ffb7e8726d5ec71996cf8b7b5ed7eacd80fed 100644 --- a/R/CreateInputsModel.default.R +++ b/R/CreateInputsModel.default.R @@ -1,7 +1,7 @@ -#' Wrapper for \code{\link[airGR]{CreateInputsModel}} for one sub-basin. +#' Wrapper for [airGR::CreateInputsModel] for one sub-basin. #' -#' @param x [function] hydrological model function (e.g. \code{\link[airGR]{RunModel_GR4J}}...) -#' @param ... arguments passed to \code{\link[airGR]{CreateInputsModel}} +#' @param x [function] hydrological model function (e.g. [airGR::RunModel_GR4J]...) +#' @param ... arguments passed to [airGR::CreateInputsModel] #' @import airGR #' @export #' diff --git a/R/CreateRunOptions.GRiwrmInputsModel.R b/R/CreateRunOptions.GRiwrmInputsModel.R index 96093fccf59d226a818f5885e5d73429208f2d6c..f8d7568be7458eeaf7516e903e8733706f96c09b 100644 --- a/R/CreateRunOptions.GRiwrmInputsModel.R +++ b/R/CreateRunOptions.GRiwrmInputsModel.R @@ -1,7 +1,7 @@ #' Create \emph{GRiwrmRunOptions} object for running and calibrating model in **airGRiwrm**. #' -#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. -#' @param ... further arguments passed to \code{\link[airGR]{CreateRunOptions}}. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see [CreateInputsModel.GRiwrm] for details. +#' @param ... further arguments passed to [airGR::CreateRunOptions]. #' #' @return \emph{GRiwrmRunOptions} object for running and calibrating model in **airGRiwrm**. #' @export diff --git a/R/CreateRunOptions.InputsModel.R b/R/CreateRunOptions.InputsModel.R index 5a77459660c6ccfd27620e51626bc2a7f77904f5..10cad9a776c49897d30fce09109779050e233087 100644 --- a/R/CreateRunOptions.InputsModel.R +++ b/R/CreateRunOptions.InputsModel.R @@ -1,7 +1,7 @@ -#' Wrapper for \code{\link[airGR]{CreateRunOptions}} for one sub-basin. +#' Wrapper for [airGR::CreateRunOptions] for one sub-basin. #' -#' @param InputsModel object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. -#' @param ... Arguments passed to \code{\link[airGR]{CreateRunOptions}} +#' @param InputsModel object of class \emph{InputsModel}, see [airGR::CreateInputsModel] for details. +#' @param ... Arguments passed to [airGR::CreateRunOptions] #' @export CreateRunOptions.InputsModel <- function(InputsModel, ...) { diff --git a/R/CreateRunOptions.R b/R/CreateRunOptions.R index 5da75ad05d4a69f50d4504c0761abc81b78cf7a7..8f8ae5741ef22dae0b15b48f97b9282d5899ffa7 100644 --- a/R/CreateRunOptions.R +++ b/R/CreateRunOptions.R @@ -1,6 +1,8 @@ -#' Create \emph{RunOptions} object for **airGR** and **airGRiwrm**. See \code{\link[airGR]{CreateRunOptions}} and \code{[CreateOptions.GRiwrmInputsModel]}. +#' Create \emph{RunOptions} object for **airGR** and **airGRiwrm**. #' -#' @param InputsModel object of class \emph{InputsModel} (see \code{\link[airGR]{CreateInputsModel}}) or \emph{GRiwrmInputsModel} (See \code{[CreateInputsModel.GRiwrm]}). +#' See [airGR::CreateRunOptions] and [CreateRunOptions.GRiwrmInputsModel] for usage. +#' +#' @param InputsModel object of class \emph{InputsModel} (see [airGR::CreateInputsModel]) or \emph{GRiwrmInputsModel} (See [CreateInputsModel.GRiwrm]). #' @param ... further arguments passed to or from other methods. #' #' @return Object of \emph{RunOptions} class family diff --git a/R/RunModel.GRiwrmInputsModel.R b/R/RunModel.GRiwrmInputsModel.R index 2d4ceabadb8628564d62ab5dd6e4e76224952ecd..36b8f41e1d5de04c969ce6462f55cdfd09cb3954 100644 --- a/R/RunModel.GRiwrmInputsModel.R +++ b/R/RunModel.GRiwrmInputsModel.R @@ -5,7 +5,7 @@ #' @param Param [list] of parameters. The list item names are the IDs of the sub-basins. Each item is a [numeric] [vector] #' @param ... Mandatory for S3 method signature function compatibility with generic. #' -#' @return \emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \code{\link[airGR]{RunModel}}) for each node of the semi-distributed model. +#' @return \emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \[airGR::RunModel]) for each node of the semi-distributed model. #' @export #' @examples #' ################################################################# diff --git a/R/RunModel.InputsModel.R b/R/RunModel.InputsModel.R index b21a3e9e9b6838b8548f8c5d022ae4be1e7fa14e..0267d29e303ae484a198297a95b8c344792dc2e4 100644 --- a/R/RunModel.InputsModel.R +++ b/R/RunModel.InputsModel.R @@ -1,4 +1,4 @@ -#' Wrapper for \code{\link[airGR]{RunModel}} for one sub-basin. +#' Wrapper for [airGR::RunModel] for one sub-basin. #' #' @inherit airGR::RunModel #' @param x `InputsModel` used as `InputsModel` parameter for [airGR::RunModel] diff --git a/R/RunModel.R b/R/RunModel.R index 0ac7f23a9c50d35ca70a0877a1f8f1d3693f3727..34e2088bf6794eed9de2e3f77e13ca8f6100be8b 100644 --- a/R/RunModel.R +++ b/R/RunModel.R @@ -1,6 +1,6 @@ #' RunModel function for both **airGR** InputsModel and GRiwrmInputsModel object #' -#' @param x object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}. See \code{\link{CreateInputsModel}} for details +#' @param x object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}. See [CreateInputsModel] for details #' @param ... further arguments passed to or from other methods #' #' @return Either a [list] of OutputsModel object (for GRiwrmInputsModel) or an OutputsModel object (for InputsModel) diff --git a/R/RunModel.Supervisor.R b/R/RunModel.Supervisor.R index 18b5cb425c45de816a7ca708aa0477eed0713fd5..6bb45cbe565171da5b578f895d57fc87c6da735c 100644 --- a/R/RunModel.Supervisor.R +++ b/R/RunModel.Supervisor.R @@ -5,7 +5,7 @@ #' @param Param list of parameter. The list item names are the IDs of the sub-basins. Each item is a vector of numerical parameters. #' @param ... Mandatory for S3 method signature function compatibility with generic. #' -#' @return \emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \code{\link[airGR]{RunModel}}) for each node of the semi-distributed model. +#' @return \emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See [airGR::RunModel]) for each node of the semi-distributed model. #' @export RunModel.Supervisor <- function(x, RunOptions, Param, ...) { diff --git a/R/UpdateQsimUpstream.R b/R/UpdateQsimUpstream.R index f2dd373fb6edc21f8bc39b713eb213b571249a9b..9e3fa78e99a8f5e0bdadc515be6f7ea2209e37ab 100644 --- a/R/UpdateQsimUpstream.R +++ b/R/UpdateQsimUpstream.R @@ -1,6 +1,6 @@ #' Update InputsModel$Qupstream with simulated upstream flows provided by GRiwrmOutputsModels object. #' -#' @param InputsModel \emph{InputsModel} object. See \code{\link[airGR]{CreateInputsModel}} +#' @param InputsModel \emph{InputsModel} object. See [airGR::CreateInputsModel] #' @param IndPeriod_Run numeric index of period to be used for the model run (-) #' @param OutputsModel \emph{GRiwrmOutputsModel} object provided by [RunModel.GRiwrmInputsModel]. #' diff --git a/man/Calibration.GRiwrmInputsModel.Rd b/man/Calibration.GRiwrmInputsModel.Rd index 8416c823c6282ca26aa817d74ec4337a859379fe..2b9699b2ce0e3a71b966339ee3b3640bf10934f0 100644 --- a/man/Calibration.GRiwrmInputsModel.Rd +++ b/man/Calibration.GRiwrmInputsModel.Rd @@ -14,20 +14,20 @@ ) } \arguments{ -\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details.} +\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \link{CreateInputsModel.GRiwrm} for details.} -\item{RunOptions}{object of class \emph{GRiwrmRunOptions}, see \code{\link{CreateRunOptions.GRiwrmInputsModel}} for details.} +\item{RunOptions}{object of class \emph{GRiwrmRunOptions}, see \link{CreateRunOptions.GRiwrmInputsModel} for details.} -\item{InputsCrit}{object of class \emph{GRiwrmInputsCrit}, see \code{\link{CreateInputsCrit.GRiwrmInputsModel}} for details.} +\item{InputsCrit}{object of class \emph{GRiwrmInputsCrit}, see \link{CreateInputsCrit.GRiwrmInputsModel} for details.} -\item{CalibOptions}{object of class \emph{GRiwrmCalibOptions}, see \code{\link{CreateCalibOptions.GRiwrmInputsModel}} for details.} +\item{CalibOptions}{object of class \emph{GRiwrmCalibOptions}, see \link{CreateCalibOptions.GRiwrmInputsModel} for details.} \item{useUpstreamQsim}{boolean describing if simulated (\code{TRUE}) or observed (\code{FALSE}) flows are used for calibration. Default is \code{TRUE}.} -\item{...}{further arguments passed to \code{\link[airGR]{Calibration}}.} +\item{...}{further arguments passed to \link[airGR:Calibration]{airGR::Calibration}.} } \value{ -GRiwrmOutputsCalib object which is a list of OutputsCalib (See \code{\link[airGR]{Calibration}}) for each node of the semi-distributed model. +GRiwrmOutputsCalib object which is a list of OutputsCalib (See \link[airGR:Calibration]{airGR::Calibration}) for each node of the semi-distributed model. } \description{ Calibration of a semi-distributed run-off model diff --git a/man/Calibration.InputsModel.Rd b/man/Calibration.InputsModel.Rd index 3dc633124bf65dda36b578d7bea6f1b16ddb77ed..ce58b1fc02d4235954e8c944c6f9d4f06b49d50e 100644 --- a/man/Calibration.InputsModel.Rd +++ b/man/Calibration.InputsModel.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/Calibration.InputsModel.R \name{Calibration.InputsModel} \alias{Calibration.InputsModel} -\title{Wrapper to \code{\link[airGR]{Calibration}} for one sub-basin.} +\title{Wrapper to \link[airGR:Calibration]{airGR::Calibration} for one sub-basin.} \usage{ \method{Calibration}{InputsModel}(InputsModel, ...) } diff --git a/man/CreateCalibOptions.GRiwrmInputsModel.Rd b/man/CreateCalibOptions.GRiwrmInputsModel.Rd index 32e6a67a00769f8f252110e3c5584ac4b30900b5..dc4125fbc385ab17e6bdfd44fe9699a7ce6d6868 100644 --- a/man/CreateCalibOptions.GRiwrmInputsModel.Rd +++ b/man/CreateCalibOptions.GRiwrmInputsModel.Rd @@ -7,9 +7,9 @@ \method{CreateCalibOptions}{GRiwrmInputsModel}(InputsModel, ...) } \arguments{ -\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details.} +\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \link{CreateInputsModel.GRiwrm} for details.} -\item{...}{further arguments passed to \code{\link[airGR]{CreateCalibOptions}}.} +\item{...}{further arguments passed to \link[airGR:CreateCalibOptions]{airGR::CreateCalibOptions}.} } \value{ \emph{GRiwrmCalibOptions} object. diff --git a/man/CreateCalibOptions.InputsModel.Rd b/man/CreateCalibOptions.InputsModel.Rd index ef3962d067cc5d604f5c5ed7d557af0ea1ae478f..e63f6c93b399134fecc1fc4b16847fa8b547b009 100644 --- a/man/CreateCalibOptions.InputsModel.Rd +++ b/man/CreateCalibOptions.InputsModel.Rd @@ -2,15 +2,15 @@ % Please edit documentation in R/CreateCalibOptions.InputsModel.R \name{CreateCalibOptions.InputsModel} \alias{CreateCalibOptions.InputsModel} -\title{Wrapper to \code{\link[airGR]{CreateCalibOptions}} for one sub-basin.} +\title{Wrapper to \link[airGR:CreateCalibOptions]{airGR::CreateCalibOptions} for one sub-basin.} \usage{ \method{CreateCalibOptions}{InputsModel}(InputsModel, ...) } \arguments{ -\item{InputsModel}{object of class \emph{InputsModel}. See \code{\link[airGR]{CreateInputsModel}} for details} +\item{InputsModel}{object of class \emph{InputsModel}. See \link[airGR:CreateInputsModel]{airGR::CreateInputsModel} for details} -\item{...}{Arguments passed to \code{\link[airGR]{CreateCalibOptions}}} +\item{...}{Arguments passed to \link[airGR:CreateCalibOptions]{airGR::CreateCalibOptions}} } \description{ -Wrapper to \code{\link[airGR]{CreateCalibOptions}} for one sub-basin. +Wrapper to \link[airGR:CreateCalibOptions]{airGR::CreateCalibOptions} for one sub-basin. } diff --git a/man/CreateCalibOptions.Rd b/man/CreateCalibOptions.Rd index 3a697aec0225f125f3c6e750743128b3bfde4b43..8ce87f6341101be07afb980d1c0ca1cf6d54fc94 100644 --- a/man/CreateCalibOptions.Rd +++ b/man/CreateCalibOptions.Rd @@ -7,7 +7,7 @@ CreateCalibOptions(InputsModel, ...) } \arguments{ -\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRwirmInputsModel}. See \code{\link{CreateInputsModel}} for details} +\item{InputsModel}{object of class \emph{InputsModel} or \emph{GRwirmInputsModel}. See \link{CreateInputsModel} for details} \item{...}{further arguments passed to or from other methods} } diff --git a/man/CreateInputsCrit.GRiwrmInputsModel.Rd b/man/CreateInputsCrit.GRiwrmInputsModel.Rd index 68d659ffe1cf70043ace18e6e0cd0790fd46c6ad..fb0733609ef2ed2956b243002c772319b39d7f8c 100644 --- a/man/CreateInputsCrit.GRiwrmInputsModel.Rd +++ b/man/CreateInputsCrit.GRiwrmInputsModel.Rd @@ -13,11 +13,11 @@ ) } \arguments{ -\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details.} +\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \link{CreateInputsModel.GRiwrm} for details.} -\item{FUN_CRIT}{[function (atomic or list)] error criterion function (e.g. \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}})} +\item{FUN_CRIT}{[function (atomic or list)] error criterion function (e.g. \link[airGR:ErrorCrit_RMSE]{airGR::ErrorCrit_RMSE}, \link[airGR:ErrorCrit_NSE]{airGR::ErrorCrit_NSE})} -\item{RunOptions}{object of class \emph{GRiwrmRunOptions}, see \code{[CreateRunOptions.GRiwrm]} for details.} +\item{RunOptions}{object of class \emph{GRiwrmRunOptions}, see \link{CreateRunOptions.GRiwrm} for details.} \item{Qobs}{matrix or data frame containing observed flows. Column names correspond to nodes ID} diff --git a/man/CreateInputsCrit.InputsModel.Rd b/man/CreateInputsCrit.InputsModel.Rd index 2636e24feffde0c36b659ac56fc83e4e30b57055..b1869a7925fc9d0d4d6cd292fa362309c6722362 100644 --- a/man/CreateInputsCrit.InputsModel.Rd +++ b/man/CreateInputsCrit.InputsModel.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/CreateInputsCrit.InputsModel.R \name{CreateInputsCrit.InputsModel} \alias{CreateInputsCrit.InputsModel} -\title{Wrapper to \code{\link[airGR]{CreateInputsCrit}} for one sub-basin.} +\title{Wrapper to \link[airGR:CreateInputsCrit]{airGR::CreateInputsCrit} for one sub-basin.} \usage{ \method{CreateInputsCrit}{InputsModel}(InputsModel, FUN_CRIT, ...) } diff --git a/man/CreateInputsCrit.Rd b/man/CreateInputsCrit.Rd index c2178e6ed183f4c4a71a08d5fa0df331d55ee264..6f368379a4abf51883bd1310dde2caa844180a21 100644 --- a/man/CreateInputsCrit.Rd +++ b/man/CreateInputsCrit.Rd @@ -7,7 +7,7 @@ CreateInputsCrit(InputsModel, ...) } \arguments{ -\item{InputsModel}{InputsModel for \strong{airGRiwrm} (See \code{[CreateInputsModel.GRiwrm]}) or \strong{airGR} (See \code{\link[airGR]{CreateInputsModel}})} +\item{InputsModel}{InputsModel for \strong{airGRiwrm} (See \code{[CreateInputsModel.GRiwrmInputsModel]}) or \strong{airGR} (See \link[airGR:CreateInputsModel]{airGR::CreateInputsModel})} \item{...}{further arguments passed to or from other methods.} } diff --git a/man/CreateInputsModel.GRiwrm.Rd b/man/CreateInputsModel.GRiwrm.Rd index 4ddeb948ca0663df711436feda5348d82de78a37..edec1ce86b9492dfde9057d7488415a2eb416cce 100644 --- a/man/CreateInputsModel.GRiwrm.Rd +++ b/man/CreateInputsModel.GRiwrm.Rd @@ -17,10 +17,10 @@ \item{Qobs}{Matrix or data frame of numeric containing potential observed flow in mm. Column names correspond to node IDs.} -\item{...}{further arguments passed to \code{\link[airGR]{CreateInputsModel}}.} +\item{...}{further arguments passed to \link[airGR:CreateInputsModel]{airGR::CreateInputsModel}.} } \value{ -GRiwrmInputsModel object equivalent to \strong{airGR} InputsModel object for a semi-distributed model (See \code{\link[airGR]{CreateInputsModel}}) +GRiwrmInputsModel object equivalent to \strong{airGR} InputsModel object for a semi-distributed model (See \link[airGR:CreateInputsModel]{airGR::CreateInputsModel}) } \description{ Create InputsModel object for a \strong{airGRiwrm} network diff --git a/man/CreateInputsModel.default.Rd b/man/CreateInputsModel.default.Rd index 345337903ca00e4158fed0ac3ea9ef6752f98a8f..15ca69bd236db36b930c004116315762f9e8ba13 100644 --- a/man/CreateInputsModel.default.Rd +++ b/man/CreateInputsModel.default.Rd @@ -2,15 +2,15 @@ % Please edit documentation in R/CreateInputsModel.default.R \name{CreateInputsModel.default} \alias{CreateInputsModel.default} -\title{Wrapper for \code{\link[airGR]{CreateInputsModel}} for one sub-basin.} +\title{Wrapper for \link[airGR:CreateInputsModel]{airGR::CreateInputsModel} for one sub-basin.} \usage{ \method{CreateInputsModel}{default}(x, ...) } \arguments{ -\item{x}{\link{function} hydrological model function (e.g. \code{\link[airGR]{RunModel_GR4J}}...)} +\item{x}{\link{function} hydrological model function (e.g. \link[airGR:RunModel_GR4J]{airGR::RunModel_GR4J}...)} -\item{...}{arguments passed to \code{\link[airGR]{CreateInputsModel}}} +\item{...}{arguments passed to \link[airGR:CreateInputsModel]{airGR::CreateInputsModel}} } \description{ -Wrapper for \code{\link[airGR]{CreateInputsModel}} for one sub-basin. +Wrapper for \link[airGR:CreateInputsModel]{airGR::CreateInputsModel} for one sub-basin. } diff --git a/man/CreateRunOptions.GRiwrmInputsModel.Rd b/man/CreateRunOptions.GRiwrmInputsModel.Rd index 844ab0e2e2f1123cdbc2daf519762721db71b55d..c03d50650fb39f87a939aabad4cc70aa2bff3c77 100644 --- a/man/CreateRunOptions.GRiwrmInputsModel.Rd +++ b/man/CreateRunOptions.GRiwrmInputsModel.Rd @@ -7,9 +7,9 @@ \method{CreateRunOptions}{GRiwrmInputsModel}(InputsModel, ...) } \arguments{ -\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details.} +\item{InputsModel}{object of class \emph{GRiwrmInputsModel}, see \link{CreateInputsModel.GRiwrm} for details.} -\item{...}{further arguments passed to \code{\link[airGR]{CreateRunOptions}}.} +\item{...}{further arguments passed to \link[airGR:CreateRunOptions]{airGR::CreateRunOptions}.} } \value{ \emph{GRiwrmRunOptions} object for running and calibrating model in \strong{airGRiwrm}. diff --git a/man/CreateRunOptions.InputsModel.Rd b/man/CreateRunOptions.InputsModel.Rd index 9533022db3cc03af90eee73fec5f1450d1ec2a1c..f00b88393a2b26433b9245f6a20f2cd907ecb6e3 100644 --- a/man/CreateRunOptions.InputsModel.Rd +++ b/man/CreateRunOptions.InputsModel.Rd @@ -2,15 +2,15 @@ % Please edit documentation in R/CreateRunOptions.InputsModel.R \name{CreateRunOptions.InputsModel} \alias{CreateRunOptions.InputsModel} -\title{Wrapper for \code{\link[airGR]{CreateRunOptions}} for one sub-basin.} +\title{Wrapper for \link[airGR:CreateRunOptions]{airGR::CreateRunOptions} for one sub-basin.} \usage{ \method{CreateRunOptions}{InputsModel}(InputsModel, ...) } \arguments{ -\item{InputsModel}{object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details.} +\item{InputsModel}{object of class \emph{InputsModel}, see \link[airGR:CreateInputsModel]{airGR::CreateInputsModel} for details.} -\item{...}{Arguments passed to \code{\link[airGR]{CreateRunOptions}}} +\item{...}{Arguments passed to \link[airGR:CreateRunOptions]{airGR::CreateRunOptions}} } \description{ -Wrapper for \code{\link[airGR]{CreateRunOptions}} for one sub-basin. +Wrapper for \link[airGR:CreateRunOptions]{airGR::CreateRunOptions} for one sub-basin. } diff --git a/man/CreateRunOptions.Rd b/man/CreateRunOptions.Rd index 486ef6b1e43a28922c5a474f74374c968a0a8bca..37c85d611ef4176512a13eb504b5ec3f5a52ca03 100644 --- a/man/CreateRunOptions.Rd +++ b/man/CreateRunOptions.Rd @@ -2,12 +2,12 @@ % Please edit documentation in R/CreateRunOptions.R \name{CreateRunOptions} \alias{CreateRunOptions} -\title{Create \emph{RunOptions} object for \strong{airGR} and \strong{airGRiwrm}. See \code{\link[airGR]{CreateRunOptions}} and \code{[CreateOptions.GRiwrmInputsModel]}.} +\title{Create \emph{RunOptions} object for \strong{airGR} and \strong{airGRiwrm}.} \usage{ CreateRunOptions(InputsModel, ...) } \arguments{ -\item{InputsModel}{object of class \emph{InputsModel} (see \code{\link[airGR]{CreateInputsModel}}) or \emph{GRiwrmInputsModel} (See \code{[CreateInputsModel.GRiwrm]}).} +\item{InputsModel}{object of class \emph{InputsModel} (see \link[airGR:CreateInputsModel]{airGR::CreateInputsModel}) or \emph{GRiwrmInputsModel} (See \link{CreateInputsModel.GRiwrm}).} \item{...}{further arguments passed to or from other methods.} } @@ -15,5 +15,5 @@ CreateRunOptions(InputsModel, ...) Object of \emph{RunOptions} class family } \description{ -Create \emph{RunOptions} object for \strong{airGR} and \strong{airGRiwrm}. See \code{\link[airGR]{CreateRunOptions}} and \code{[CreateOptions.GRiwrmInputsModel]}. +See \link[airGR:CreateRunOptions]{airGR::CreateRunOptions} and \link{CreateRunOptions.GRiwrmInputsModel} for usage. } diff --git a/man/RunModel.GRiwrmInputsModel.Rd b/man/RunModel.GRiwrmInputsModel.Rd index 545a86fd52be4befdf53527e07f0f60ebb125209..045a29b69fc25d8a86d4264a91fd8febc29ed0b3 100644 --- a/man/RunModel.GRiwrmInputsModel.Rd +++ b/man/RunModel.GRiwrmInputsModel.Rd @@ -16,7 +16,7 @@ \item{...}{Mandatory for S3 method signature function compatibility with generic.} } \value{ -\emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \code{\link[airGR]{RunModel}}) for each node of the semi-distributed model. +\emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See [airGR::RunModel]) for each node of the semi-distributed model. } \description{ RunModel function for GRiwrmInputsModel object diff --git a/man/RunModel.InputsModel.Rd b/man/RunModel.InputsModel.Rd index 6e97966c4cd33b70b8e67f98df0de892427dc8d6..116de2ce9ea6df30790e38e9bb2f0d4e704f68c9 100644 --- a/man/RunModel.InputsModel.Rd +++ b/man/RunModel.InputsModel.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/RunModel.InputsModel.R \name{RunModel.InputsModel} \alias{RunModel.InputsModel} -\title{Wrapper for \code{\link[airGR]{RunModel}} for one sub-basin.} +\title{Wrapper for \link[airGR:RunModel]{airGR::RunModel} for one sub-basin.} \usage{ \method{RunModel}{InputsModel}(x, RunOptions, Param, FUN_MOD = NULL, ...) } diff --git a/man/RunModel.Rd b/man/RunModel.Rd index 495e3b8c87b238b953f4e657fb844b5b6f967d70..7747c16fe0cdafb68e599760bb29946f724fc637 100644 --- a/man/RunModel.Rd +++ b/man/RunModel.Rd @@ -7,7 +7,7 @@ RunModel(x, ...) } \arguments{ -\item{x}{object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}. See \code{\link{CreateInputsModel}} for details} +\item{x}{object of class \emph{InputsModel} or \emph{GRiwrmInputsModel}. See \link{CreateInputsModel} for details} \item{...}{further arguments passed to or from other methods} } diff --git a/man/RunModel.Supervisor.Rd b/man/RunModel.Supervisor.Rd index 0d2f6428fe62bc78a99605e53a275a92f3b0c27d..f5341cf0881f91e1be8b7b736a8991c80a6fb478 100644 --- a/man/RunModel.Supervisor.Rd +++ b/man/RunModel.Supervisor.Rd @@ -16,7 +16,7 @@ \item{...}{Mandatory for S3 method signature function compatibility with generic.} } \value{ -\emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \code{\link[airGR]{RunModel}}) for each node of the semi-distributed model. +\emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \link[airGR:RunModel]{airGR::RunModel}) for each node of the semi-distributed model. } \description{ RunModel function for GRiwrmInputsModel object diff --git a/man/UpdateQsimUpstream.Rd b/man/UpdateQsimUpstream.Rd index f6153812ed3970e9b203b77918a1327f41b1b3e2..c276ed8eb08fbdc3a0838f1b246111209b329fae 100644 --- a/man/UpdateQsimUpstream.Rd +++ b/man/UpdateQsimUpstream.Rd @@ -7,7 +7,7 @@ UpdateQsimUpstream(InputsModel, IndPeriod_Run, OutputsModel) } \arguments{ -\item{InputsModel}{\emph{InputsModel} object. See \code{\link[airGR]{CreateInputsModel}}} +\item{InputsModel}{\emph{InputsModel} object. See \link[airGR:CreateInputsModel]{airGR::CreateInputsModel}} \item{IndPeriod_Run}{numeric index of period to be used for the model run (-)}