Commit eeba0367 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v1.6.9.4 docs(man): add usage of '['.InputsModel and '['.OutputsModel in...

v1.6.9.4 docs(man): add usage of '['.InputsModel and '['.OutputsModel in CreateInputsModel and RunModel help pages
Refs #67
parent 05cf434b
Pipeline #18977 passed with stages
in 14 minutes and 7 seconds
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.6.9.3
Version: 1.6.9.4
Date: 2021-01-08
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
......
......@@ -2,7 +2,7 @@
### 1.6.9.3 Release Notes (2021-01-08)
### 1.6.9.4 Release Notes (2021-01-08)
#### New features
......
......@@ -3,6 +3,7 @@
\name{CreateInputsModel}
\alias{CreateInputsModel}
\alias{[.InputsModel}
\title{Creation of the InputsModel object required to the RunModel functions}
......@@ -19,6 +20,8 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
ZInputs = NULL, HypsoData = NULL, NLayers = 5,
Qupstream = NULL, LengthHydro = NULL, BasinAreas = NULL,
verbose = TRUE)
\method{[}{InputsModel}(x, i)
}
......@@ -53,6 +56,9 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
\item{BasinAreas}{(optional) [numeric] real giving the area of each upstream sub-catchment [km2] and the area of the downstream sub-catchment in the last item, required to create the SD model inputs (see details)}
\item{x}{[InputsModel] object of class InputsModel}
\item{i}{[integer] elements to extract}
}
......
......@@ -3,6 +3,7 @@
\name{RunModel}
\alias{RunModel}
\alias{[.OutputsModel}
\title{Run with the provided hydrological model function}
......@@ -15,6 +16,8 @@ Function which performs a single model run with the provided function over the s
\usage{
RunModel(InputsModel, RunOptions, Param, FUN_MOD)
\method{[}{OutputsModel}(x, i)
}
......@@ -26,6 +29,10 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD)
\item{Param}{[numeric] vector of model parameters (See details for SD lag model)}
\item{FUN_MOD}{[function] hydrological model function (e.g. \code{\link{RunModel_GR4J}}, \code{\link{RunModel_CemaNeigeGR4J}})}
\item{x}{[InputsModel] object of class InputsModel}
\item{i}{[integer] elements to extract}
}
......
Markdown is supported
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