From 749e9fa99384df76db6fbadfa9f397573a820b9e Mon Sep 17 00:00:00 2001 From: unknown <olivier.delaigue@ANPI1430.antony.irstea.priv> Date: Tue, 25 Oct 2016 14:05:01 +0200 Subject: [PATCH] Formatting example --- man/BasinInfo.Rd | 2 +- man/Calibration.Rd | 3 ++- man/Calibration_Michel.Rd | 3 ++- man/CreateCalibOptions.Rd | 3 ++- man/CreateInputsCrit.Rd | 3 ++- man/CreateInputsModel.Rd | 3 ++- man/CreateRunOptions.Rd | 3 ++- man/ErrorCrit.Rd | 3 ++- man/PEdaily_Oudin.Rd | 2 +- man/RunModel.Rd | 3 ++- man/RunModel_CemaNeige.Rd | 3 ++- man/RunModel_CemaNeigeGR4J.Rd | 3 ++- man/RunModel_CemaNeigeGR5J.Rd | 3 ++- man/RunModel_CemaNeigeGR6J.Rd | 3 ++- man/RunModel_GR1A.Rd | 3 ++- man/RunModel_GR2M.Rd | 3 ++- man/RunModel_GR4H.Rd | 3 ++- man/RunModel_GR4J.Rd | 3 ++- man/RunModel_GR5J.Rd | 3 ++- man/RunModel_GR6J.Rd | 3 ++- 20 files changed, 38 insertions(+), 20 deletions(-) diff --git a/man/BasinInfo.Rd b/man/BasinInfo.Rd index a8d60333..faf45439 100644 --- a/man/BasinInfo.Rd +++ b/man/BasinInfo.Rd @@ -13,7 +13,7 @@ R-object containing the code, station's name, area and hypsometric curve of the catchment. } \examples{ - require(airGR) + library(airGR) data(L0123001) str(BasinInfo) } diff --git a/man/Calibration.Rd b/man/Calibration.Rd index 316576df..8c363568 100644 --- a/man/Calibration.Rd +++ b/man/Calibration.Rd @@ -33,8 +33,9 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD, Calibration algorithm which optimises the error criterion selected as objective function using the provided functions. \cr } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of InputsModel object diff --git a/man/Calibration_Michel.Rd b/man/Calibration_Michel.Rd index 73a26ee2..8dc0d925 100644 --- a/man/Calibration_Michel.Rd +++ b/man/Calibration_Michel.Rd @@ -61,8 +61,9 @@ the progression speed. A composite step can occasionally be done. \cr The calibration algorithm stops when the search step becomes smaller than a predefined threshold. \cr } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of InputsModel object diff --git a/man/CreateCalibOptions.Rd b/man/CreateCalibOptions.Rd index 085d3a06..def8e431 100644 --- a/man/CreateCalibOptions.Rd +++ b/man/CreateCalibOptions.Rd @@ -72,8 +72,9 @@ Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not in the package must create their own CalibOptions object accordingly. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of InputsModel object diff --git a/man/CreateInputsCrit.Rd b/man/CreateInputsCrit.Rd index 8467e8a6..7f6e2d26 100644 --- a/man/CreateInputsCrit.Rd +++ b/man/CreateInputsCrit.Rd @@ -41,8 +41,9 @@ Users wanting to use FUN_CRIT functions that are not included in the package must create their own InputsCrit object accordingly. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object diff --git a/man/CreateInputsModel.Rd b/man/CreateInputsModel.Rd index 3e5b1198..e9788fed 100644 --- a/man/CreateInputsModel.Rd +++ b/man/CreateInputsModel.Rd @@ -49,8 +49,9 @@ Users wanting to use FUN_MOD functions that are not included in the package must create their own InputsModel object accordingly. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object diff --git a/man/CreateRunOptions.Rd b/man/CreateRunOptions.Rd index b7dba508..ab45807e 100644 --- a/man/CreateRunOptions.Rd +++ b/man/CreateRunOptions.Rd @@ -82,8 +82,9 @@ However, it is also possible to perform a long-term initialisation if other indi } } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object diff --git a/man/ErrorCrit.Rd b/man/ErrorCrit.Rd index bc299410..c035b961 100644 --- a/man/ErrorCrit.Rd +++ b/man/ErrorCrit.Rd @@ -21,8 +21,9 @@ ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, verbose = TRUE) Function which computes an error criterion with the provided function. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object diff --git a/man/PEdaily_Oudin.Rd b/man/PEdaily_Oudin.Rd index 5c77052b..57688fdf 100644 --- a/man/PEdaily_Oudin.Rd +++ b/man/PEdaily_Oudin.Rd @@ -19,7 +19,7 @@ PEdaily_Oudin(JD, Temp, LatRad) Function which computes daily PE using the formula from Oudin et al. (2005). } \examples{ - require(airGR) + library(airGR) data(L0123001) PotEvap <- PEdaily_Oudin(JD=as.POSIXlt(BasinObs$DatesR)$yday,Temp=BasinObs$T,LatRad=0.8) } diff --git a/man/RunModel.Rd b/man/RunModel.Rd index 5f19b724..e7e3e3a9 100644 --- a/man/RunModel.Rd +++ b/man/RunModel.Rd @@ -21,8 +21,9 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD) Function which performs a single model run with the provided function over the selected period. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd index da1a534c..5efa6421 100644 --- a/man/RunModel_CemaNeige.Rd +++ b/man/RunModel_CemaNeige.Rd @@ -41,8 +41,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ +library(airGR) + ## load of catchment data -require(airGR) data(L0123002) ## preparation of the InputsModel object diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd index 56dada77..102ca348 100644 --- a/man/RunModel_CemaNeigeGR4J.Rd +++ b/man/RunModel_CemaNeigeGR4J.Rd @@ -59,8 +59,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123002) ## preparation of the InputsModel object diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd index de92a255..c7e3de7c 100644 --- a/man/RunModel_CemaNeigeGR5J.Rd +++ b/man/RunModel_CemaNeigeGR5J.Rd @@ -60,8 +60,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123002) ## preparation of the InputsModel object diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd index f9327e77..a465d934 100644 --- a/man/RunModel_CemaNeigeGR6J.Rd +++ b/man/RunModel_CemaNeigeGR6J.Rd @@ -63,8 +63,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123002) ## preparation of the InputsModel object diff --git a/man/RunModel_GR1A.Rd b/man/RunModel_GR1A.Rd index 9b44d33c..1be73d0e 100644 --- a/man/RunModel_GR1A.Rd +++ b/man/RunModel_GR1A.Rd @@ -34,8 +34,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## conversion of example data from daily to yearly time step diff --git a/man/RunModel_GR2M.Rd b/man/RunModel_GR2M.Rd index e551d1b0..05723782 100644 --- a/man/RunModel_GR2M.Rd +++ b/man/RunModel_GR2M.Rd @@ -35,8 +35,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## conversion of example data from daily to monthly time step diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd index e24d6c57..9e8e4775 100644 --- a/man/RunModel_GR4H.Rd +++ b/man/RunModel_GR4H.Rd @@ -48,8 +48,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ +library(airGR) + ## load of catchment data -require(airGR) data(L0123003) ## preparation of the InputsModel object diff --git a/man/RunModel_GR4J.Rd b/man/RunModel_GR4J.Rd index 07966bdb..7f584ed8 100644 --- a/man/RunModel_GR4J.Rd +++ b/man/RunModel_GR4J.Rd @@ -48,8 +48,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object diff --git a/man/RunModel_GR5J.Rd b/man/RunModel_GR5J.Rd index 03565663..bd058061 100644 --- a/man/RunModel_GR5J.Rd +++ b/man/RunModel_GR5J.Rd @@ -49,8 +49,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object diff --git a/man/RunModel_GR6J.Rd b/man/RunModel_GR6J.Rd index d20806de..e5409344 100644 --- a/man/RunModel_GR6J.Rd +++ b/man/RunModel_GR6J.Rd @@ -52,8 +52,9 @@ For further details on the model, see the references section. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. } \examples{ -## loading catchment data library(airGR) + +## loading catchment data data(L0123001) ## preparation of the InputsModel object -- GitLab