Commit fa48c8a5 authored by Dorchies David's avatar Dorchies David
Browse files

doc: clean links in documentation

Showing with 44 additions and 42 deletions
+44 -42
#' 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,
......
#' 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
......
#' 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
......
#' 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,
...) {
......
#' 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
......
......@@ -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].
#'
......
#' 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
......
#' 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
......
......@@ -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
#' #################################################################
......
#' 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
#'
......
#' 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
......
#' 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, ...) {
......
#' 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
......
......@@ -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
#' #################################################################
......
#' 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]
......
#' 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)
......
......@@ -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, ...) {
......
#' 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].
#'
......
......@@ -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
......
......@@ -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, ...)
}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment