Commit 6a2b07d6 authored by Dorchies David's avatar Dorchies David
Browse files

doc: renaming last GR-IWRM to airGRiwrm

Showing with 13 additions and 13 deletions
+13 -13
#' Calibration of either airGR model and GRIWRM semi-distributive model
#' Calibration of either **airGR** model and **airGRiwrm** semi-distributive model
#'
#' @param InputsModel the class of the first parameter determine which calibration is used
#' @param ... further arguments passed to or from other methods.
......
#' Create \emph{GRiwrmInputsCrit} object for GR-IWRM.
#' Create \emph{GRiwrmInputsCrit} object for **airGRiwrm**.
#' @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.
......
#' Create InputsModel object for a GRIWRM network
#' Create InputsModel object for a **airGRiwrm** network
#'
#' @param x GRiwrm object describing the diagram of the semi-distributed model, see \code{[GRiwrm]}.
#' @param DatesR Vector of POSIXt observation time steps.
......@@ -8,7 +8,7 @@
#' @param verbose (optional) boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}
#' @param ... further arguments passed to \code{\link[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 \code{\link[airGR]{CreateInputsModel}})
#' @export
CreateInputsModel.GRiwrm <- function(x, DatesR, Precip, PotEvap, Qobs, verbose = TRUE, ...) {
......@@ -25,7 +25,7 @@ CreateInputsModel.GRiwrm <- function(x, DatesR, Precip, PotEvap, Qobs, verbose =
}
#' Create an empty InputsModel object for GRIWRM nodes
#' Create an empty InputsModel object for **airGRiwrm** nodes
#'
#' @return \emph{GRiwrmInputsModel} empty object
CreateEmptyGRiwrmInputsModel <- function() {
......@@ -35,7 +35,7 @@ CreateEmptyGRiwrmInputsModel <- function() {
}
#' Create one InputsModel for a GRIWRM node
#' Create one InputsModel for a **airGRiwrm** node
#'
#' @param id string of the node identifier
#' @param griwrm See \code{[GRiwrm]}.
......@@ -67,7 +67,7 @@ CreateOneGRiwrmInputsModel <- function(id, griwrm, DatesR, Precip, PotEvap, Qobs
names(BasinAreas) <- c(UpstreamNodes, id)
}
# Set model inputs with the airGR function
# Set model inputs with the **airGR** function
InputsModel <- CreateInputsModel(
FUN_MOD,
DatesR = DatesR,
......
#' Create InputsModel object for either airGR or GR-IWRM
#' Create InputsModel object for either **airGR** or **airGRiwrm**
#'
#' @param x First parameter determining which InputsModel object is created
#' @param ... further arguments passed to or from other methods.
......
#' Create \emph{GRiwrmRunOptions} object for running and calibrating model in GR-IWRM.
#' 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}}.
#'
#' @return \emph{GRiwrmRunOptions} object for running and calibrating model in GR-IWRM.
#' @return \emph{GRiwrmRunOptions} object for running and calibrating model in **airGRiwrm**.
#' @export
CreateRunOptions.GRiwrmInputsModel <- function(InputsModel, ...) {
......
#' Create \emph{RunOptions} object for airGR and GR-IWRM. See \code{\link[airGR]{CreateRunOptions}} and \code{[CreateOptions.GRiwrmInputsModel]}.
#' Create \emph{RunOptions} object for **airGR** and **airGRiwrm**. See \code{\link[airGR]{CreateRunOptions}} and \code{[CreateOptions.GRiwrmInputsModel]}.
#'
#' @param InputsModel object of class \emph{InputsModel} (see \code{\link[airGR]{CreateInputsModel}}) or \emph{GRiwrmInputsModel} (See \code{[CreateInputsModel.GRiwrm]}).
#' @param ... further arguments passed to or from other methods.
......
# airGRiwrm: airGR based Integrated Water Resource Management R package
airGRiwrm is an extension of the airGR R package for managing semi-distributive hydrological model on an anthropized catchment.
**airGRiwrm** is an extension of the **airGR** R package for managing semi-distributive hydrological model on an anthropized catchment.
This package is developed as part of the IN-WOP project (http://www.waterjpi.eu/joint-calls/joint-call-2018-waterworks-2017/booklet/in-wop) by the mixed research unit G-EAU (https://g-eau.fr).
......@@ -8,7 +8,7 @@ This package is developed as part of the IN-WOP project (http://www.waterjpi.eu/
### Requirements
This package depends on airGR version 1.6. or more which is currently under development. To install it, use the following instruction:
This package depends on **airGR** version 1.6. or more which is currently under development. To install it, use the following instruction:
```
remotes::install_gitlab("HYCAR-Hydro/airgr@dev", host = "gitlab.irstea.fr")
......
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