From eeba036777a032445576833e0c4dca4b466e6564 Mon Sep 17 00:00:00 2001 From: Delaigue Olivier <olivier.delaigue@irstea.fr> Date: Fri, 8 Jan 2021 10:22:40 +0100 Subject: [PATCH] v1.6.9.4 docs(man): add usage of '['.InputsModel and '['.OutputsModel in CreateInputsModel and RunModel help pages Refs #67 --- DESCRIPTION | 2 +- NEWS.md | 2 +- man/CreateInputsModel.Rd | 6 ++++++ man/RunModel.Rd | 7 +++++++ 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 58626d6f..9ef58452 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ 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")), diff --git a/NEWS.md b/NEWS.md index f8114bdf..7bd9a3aa 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,7 @@ -### 1.6.9.3 Release Notes (2021-01-08) +### 1.6.9.4 Release Notes (2021-01-08) #### New features diff --git a/man/CreateInputsModel.Rd b/man/CreateInputsModel.Rd index 3716e101..cab3a276 100644 --- a/man/CreateInputsModel.Rd +++ b/man/CreateInputsModel.Rd @@ -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} } diff --git a/man/RunModel.Rd b/man/RunModel.Rd index ceae5f1d..7037f105 100644 --- a/man/RunModel.Rd +++ b/man/RunModel.Rd @@ -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} } -- GitLab