From 4447886db3652e7db6cd01baf6e548864f47c29d Mon Sep 17 00:00:00 2001
From: Olivier Delaigue <olivier.delaigue@irstea.fr>
Date: Wed, 9 Dec 2015 09:19:28 +0100
Subject: [PATCH] Version 0.8.1.2
---
DESCRIPTION | 20 +++++++++++---------
NAMESPACE | 2 +-
R/CreateInputsModel.R | 1 +
R/ErrorCrit.R | 2 +-
R/RunModel.R | 2 +-
R/RunModel_CemaNeige.R | 4 ++--
R/RunModel_CemaNeigeGR4J.R | 6 +++---
R/RunModel_CemaNeigeGR5J.R | 6 +++---
R/RunModel_CemaNeigeGR6J.R | 6 +++---
R/RunModel_GR1A.R | 4 ++--
R/RunModel_GR2M.R | 4 ++--
R/RunModel_GR4H.R | 4 ++--
R/RunModel_GR4J.R | 4 ++--
R/RunModel_GR5J.R | 4 ++--
R/RunModel_GR6J.R | 4 ++--
man/BasinInfo.Rd | 4 ++--
man/BasinObs.Rd | 4 ++--
man/Calibration.Rd | 4 ++--
man/Calibration_HBAN.Rd | 20 ++++++++++----------
man/Calibration_optim.Rd | 6 +++---
man/CreateCalibOptions.Rd | 4 ++--
man/CreateInputsCrit.Rd | 4 ++--
man/CreateInputsModel.Rd | 4 ++--
man/CreateRunOptions.Rd | 6 +++---
man/DataAltiExtrapolation_HBAN.Rd | 12 ++++++------
man/ErrorCrit.Rd | 2 +-
man/ErrorCrit_KGE.Rd | 8 ++++----
man/ErrorCrit_KGE2.Rd | 10 +++++-----
man/ErrorCrit_NSE.Rd | 8 ++++----
man/ErrorCrit_RMSE.Rd | 6 +++---
man/PEdaily_Oudin.Rd | 8 ++++----
man/RunModel.Rd | 2 +-
man/RunModel_CemaNeige.Rd | 18 +++++++++---------
man/RunModel_CemaNeigeGR4J.Rd | 22 +++++++++++-----------
man/RunModel_CemaNeigeGR5J.Rd | 24 ++++++++++++------------
man/RunModel_CemaNeigeGR6J.Rd | 22 +++++++++++-----------
man/RunModel_GR1A.Rd | 12 ++++++------
man/RunModel_GR2M.Rd | 12 ++++++------
man/RunModel_GR4H.Rd | 14 +++++++-------
man/RunModel_GR4J.Rd | 14 +++++++-------
man/RunModel_GR5J.Rd | 14 +++++++-------
man/RunModel_GR6J.Rd | 14 +++++++-------
man/SeriesAggreg.Rd | 2 +-
man/TransfoParam.Rd | 2 +-
man/TransfoParam_CemaNeige.Rd | 2 +-
man/TransfoParam_GR1A.Rd | 2 +-
man/TransfoParam_GR2M.Rd | 2 +-
man/TransfoParam_GR4H.Rd | 2 +-
man/TransfoParam_GR4J.Rd | 2 +-
man/TransfoParam_GR5J.Rd | 2 +-
man/TransfoParam_GR6J.Rd | 2 +-
man/airGR.Rd | 4 ++--
man/plot_OutputsModel.Rd | 2 +-
53 files changed, 189 insertions(+), 186 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index fafb3d22..b858654e 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -2,15 +2,17 @@ Package: airGR
Type: Package
Title: Modelling tools used at Irstea-HBAN (France), including GR4J and
CemaNeige
-Version: 0.8.1.0
-Date: 2015-10-27
+Version: 0.8.1.2
+Date: 2015-21-08
Author: Laurent CORON
-Maintainer: Laurent CORON, Olivier DELAIGUE
- <olivier.delaigue@irstea.fr>
+Maintainer: Laurent CORON, Olivier DELAIGUE <airGR@irstea.fr>
Depends: R (>= 3.0.1)
-Description: This package brings into R the hydrological modelling tools used at Irstea-HBAN (France).
- The package includes several conceptual rainfall-runoff models and the associated functions
- for their calibration and evaluation (GR4H, GR4J, GR5J, GR6J, GR2M, GR1A and CemaNeige).
- Use help(airGR) for package description.
+Description: This package brings into R the hydrological modelling tools used
+ at Irstea-HBAN (France). The package includes several conceptual
+ rainfall-runoff models and the associated functions for their calibration
+ and evaluation (GR4H, GR4J, GR5J, GR6J, GR2M, GR1A and CemaNeige). Use
+ help(airGR) for package description.
License: GPL-2
-Packaged: 2015-10-27 18:41:47 UTC; H61970
+RoxygenNote: 5.0.1
+NeedsCompilation: yes
+Packaged: 2015-12-08 18:06:18 UTC; H61970
diff --git a/NAMESPACE b/NAMESPACE
index 12538e13..742ba77c 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.1.1): do not edit by hand
+# Generated by roxygen2: do not edit by hand
export(Calibration)
export(Calibration_HBAN)
diff --git a/R/CreateInputsModel.R b/R/CreateInputsModel.R
index 8dcacd06..fc0aa331 100644
--- a/R/CreateInputsModel.R
+++ b/R/CreateInputsModel.R
@@ -141,6 +141,7 @@ CreateInputsModel <- function(FUN_MOD,DatesR,Precip,PotEvap=NULL,TempMean=NULL,T
Precip <- Precip[Select]; PotEvap <- PotEvap[Select]; }
if("CemaNeige" %in% ObjectClass){
Precip <- Precip[Select]; TempMean <- TempMean[Select]; if(!is.null(TempMin) & !is.null(TempMax)){ TempMin <- TempMin[Select]; TempMax <- TempMax[Select]; } }
+ DatesR <- DatesR[Select];
WTxt <- paste(WTxt,"\t -> data were trunced to keep the most recent available time-steps \n",sep="");
WTxt <- paste(WTxt,"\t -> ",length(Select)," time-steps were kept \n",sep="");
if(!is.null(WTxt) & !quiet){ warning(WTxt); }
diff --git a/R/ErrorCrit.R b/R/ErrorCrit.R
index fe874c83..0f0a940f 100644
--- a/R/ErrorCrit.R
+++ b/R/ErrorCrit.R
@@ -5,7 +5,7 @@
#' @author Laurent Coron (June 2014)
#' @seealso \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}}, \code{\link{ErrorCrit_KGE}}
#' @example tests/example_ErrorCrit.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
diff --git a/R/RunModel.R b/R/RunModel.R
index 4acfd1e2..d4b50861 100644
--- a/R/RunModel.R
+++ b/R/RunModel.R
@@ -5,7 +5,7 @@
#' @author Laurent Coron (June 2014)
#' @seealso \code{\link{RunModel_GR4J}}, \code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
diff --git a/R/RunModel_CemaNeige.R b/R/RunModel_CemaNeige.R
index cfce9e20..b8faa0cb 100644
--- a/R/RunModel_CemaNeige.R
+++ b/R/RunModel_CemaNeige.R
@@ -15,7 +15,7 @@
#' Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
#' @seealso \code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel_CemaNeige.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -78,7 +78,7 @@ RunModel_CemaNeige <- function(InputsModel,RunOptions,Param){
##Call_DLL_CemaNeige_________________________
for(iLayer in 1:NLayers){
StateStartCemaNeige <- RunOptions$IniStates[ (2*(iLayer-1)+1):(2*(iLayer-1)+2) ];
- RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airGR",
##inputs
LInputs=as.integer(length(IndPeriod1)), ### length of input and output series
InputsPrecip=InputsModel$LayerPrecip[[iLayer]][IndPeriod1], ### input series of total precipitation [mm/d]
diff --git a/R/RunModel_CemaNeigeGR4J.R b/R/RunModel_CemaNeigeGR4J.R
index abde2411..17cad7d1 100644
--- a/R/RunModel_CemaNeigeGR4J.R
+++ b/R/RunModel_CemaNeigeGR4J.R
@@ -19,7 +19,7 @@
#' @seealso \code{\link{RunModel_CemaNeigeGR5J}}, \code{\link{RunModel_CemaNeigeGR6J}}, \code{\link{RunModel_GR4J}},
#' \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel_CemaNeigeGR4J.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -107,7 +107,7 @@ RunModel_CemaNeigeGR4J <- function(InputsModel,RunOptions,Param){
##Call_DLL_CemaNeige_________________________
for(iLayer in 1:NLayers){
StateStartCemaNeige <- RunOptions$IniStates[ (NStatesMod+2*(iLayer-1)+1):(NStatesMod+2*(iLayer-1)+2) ];
- RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$LayerPrecip[[iLayer]][IndPeriod1], ### input series of total precipitation [mm/d]
@@ -155,7 +155,7 @@ RunModel_CemaNeigeGR4J <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr4j",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr4j",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=CatchMeltAndPliq, ### input series of total precipitation [mm/d]
diff --git a/R/RunModel_CemaNeigeGR5J.R b/R/RunModel_CemaNeigeGR5J.R
index 59c37e47..d7524038 100644
--- a/R/RunModel_CemaNeigeGR5J.R
+++ b/R/RunModel_CemaNeigeGR5J.R
@@ -21,7 +21,7 @@
#' @seealso \code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{RunModel_CemaNeigeGR6J}}, \code{\link{RunModel_GR5J}},
#' \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel_CemaNeigeGR5J.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -109,7 +109,7 @@ RunModel_CemaNeigeGR5J <- function(InputsModel,RunOptions,Param){
##Call_DLL_CemaNeige_________________________
for(iLayer in 1:NLayers){
StateStartCemaNeige <- RunOptions$IniStates[ (NStatesMod+2*(iLayer-1)+1):(NStatesMod+2*(iLayer-1)+2) ];
- RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$LayerPrecip[[iLayer]][IndPeriod1], ### input series of total precipitation [mm/d]
@@ -157,7 +157,7 @@ RunModel_CemaNeigeGR5J <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr5j",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr5j",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=CatchMeltAndPliq, ### input series of total precipitation [mm/d]
diff --git a/R/RunModel_CemaNeigeGR6J.R b/R/RunModel_CemaNeigeGR6J.R
index a572ea0a..f32b0072 100644
--- a/R/RunModel_CemaNeigeGR6J.R
+++ b/R/RunModel_CemaNeigeGR6J.R
@@ -19,7 +19,7 @@
#' @seealso \code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{RunModel_CemaNeigeGR5J}}, \code{\link{RunModel_GR6J}},
#' \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel_CemaNeigeGR6J.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -111,7 +111,7 @@ RunModel_CemaNeigeGR6J <- function(InputsModel,RunOptions,Param){
##Call_DLL_CemaNeige_________________________
for(iLayer in 1:NLayers){
StateStartCemaNeige <- RunOptions$IniStates[ (NStatesMod+2*(iLayer-1)+1):(NStatesMod+2*(iLayer-1)+2) ];
- RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_cemaneige",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$LayerPrecip[[iLayer]][IndPeriod1], ### input series of total precipitation [mm/d]
@@ -159,7 +159,7 @@ RunModel_CemaNeigeGR6J <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr6j",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr6j",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=CatchMeltAndPliq, ### input series of total precipitation [mm/d]
diff --git a/R/RunModel_GR1A.R b/R/RunModel_GR1A.R
index c0525db3..f0037c6f 100644
--- a/R/RunModel_GR1A.R
+++ b/R/RunModel_GR1A.R
@@ -11,7 +11,7 @@
#' Mouelhi S. (2003),
#' Vers une chaîne cohérente de modèles pluie-débit conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et journalier,
#' PhD thesis (in French), ENGREF, Cemagref Antony, France. \cr
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -56,7 +56,7 @@ RunModel_GR1A <- function(InputsModel,RunOptions,Param){
BOOL_Fortran <- FALSE; if(BOOL_Fortran){
##Call_fortan
- RESULTS <- .Fortran("frun_gr1a",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr1a",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$Precip[IndPeriod1], ### input series of total precipitation [mm/y]
diff --git a/R/RunModel_GR2M.R b/R/RunModel_GR2M.R
index f21542a6..f8e57d31 100644
--- a/R/RunModel_GR2M.R
+++ b/R/RunModel_GR2M.R
@@ -14,7 +14,7 @@
#' Mouelhi, S., C. Michel, C. Perrin and V. Andréassian (2006),
#' Stepwise development of a two-parameter monthly water balance model,
#' Journal of Hydrology, 318(1-4), 200-214, doi:10.1016/j.jhydrol.2005.06.014.
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -76,7 +76,7 @@ RunModel_GR2M <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr2m",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr2m",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$Precip[IndPeriod1], ### input series of total precipitation [mm/month]
diff --git a/R/RunModel_GR4H.R b/R/RunModel_GR4H.R
index 2befb604..1aa9ba31 100644
--- a/R/RunModel_GR4H.R
+++ b/R/RunModel_GR4H.R
@@ -13,7 +13,7 @@
#' Mathevet, T. (2005),
#' Quels modèles pluie-débit globaux pour le pas de temps horaire ? Développement empirique et comparaison de modèles sur un large échantillon de bassins versants,
#' PhD thesis (in French), ENGREF - Cemagref (Antony), Paris, France.
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -77,7 +77,7 @@ RunModel_GR4H <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr4h",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr4h",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$Precip[IndPeriod1], ### input series of total precipitation [mm/h]
diff --git a/R/RunModel_GR4J.R b/R/RunModel_GR4J.R
index 50c7e373..8ac0918b 100644
--- a/R/RunModel_GR4J.R
+++ b/R/RunModel_GR4J.R
@@ -13,7 +13,7 @@
#' @seealso \code{\link{RunModel_GR5J}}, \code{\link{RunModel_GR6J}}, \code{\link{RunModel_CemaNeigeGR4J}},
#' \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel_GR4J.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -77,7 +77,7 @@ RunModel_GR4J <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr4j",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr4j",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$Precip[IndPeriod1], ### input series of total precipitation [mm/d]
diff --git a/R/RunModel_GR5J.R b/R/RunModel_GR5J.R
index 7d3a60ea..be26d20b 100644
--- a/R/RunModel_GR5J.R
+++ b/R/RunModel_GR5J.R
@@ -15,7 +15,7 @@
#' @seealso \code{\link{RunModel_GR4J}}, \code{\link{RunModel_GR6J}}, \code{\link{RunModel_CemaNeigeGR5J}},
#' \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel_GR5J.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -80,7 +80,7 @@ RunModel_GR5J <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr5j",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr5j",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$Precip[IndPeriod1], ### input series of total precipitation [mm/d]
diff --git a/R/RunModel_GR6J.R b/R/RunModel_GR6J.R
index b9e930a0..a3cd68a2 100644
--- a/R/RunModel_GR6J.R
+++ b/R/RunModel_GR6J.R
@@ -13,7 +13,7 @@
#' @seealso \code{\link{RunModel_GR4J}}, \code{\link{RunModel_GR5J}}, \code{\link{RunModel_CemaNeigeGR6J}},
#' \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
#' @example tests/example_RunModel_GR6J.R
-#' @useDynLib airgr
+#' @useDynLib airGR
#' @encoding UTF-8
#' @export
#_FunctionInputs__________________________________________________________________________________________________
@@ -81,7 +81,7 @@ RunModel_GR6J <- function(InputsModel,RunOptions,Param){
}
##Call_fortan
- RESULTS <- .Fortran("frun_gr6j",PACKAGE="airgr",
+ RESULTS <- .Fortran("frun_gr6j",PACKAGE="airGR",
##inputs
LInputs=LInputSeries, ### length of input and output series
InputsPrecip=InputsModel$Precip[IndPeriod1], ### input series of total precipitation [mm/d]
diff --git a/man/BasinInfo.Rd b/man/BasinInfo.Rd
index b951d612..a0df8807 100644
--- a/man/BasinInfo.Rd
+++ b/man/BasinInfo.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BasinData.R
\docType{data}
\encoding{UTF-8}
@@ -15,7 +15,7 @@
R-object containing the code, station's name, area and hypsometric curve of the catchment.
}
\examples{
-require(airGR)
+ require(airGR)
data(L0123001)
str(BasinInfo)
}
diff --git a/man/BasinObs.Rd b/man/BasinObs.Rd
index d06a1ebf..d3f1d652 100644
--- a/man/BasinObs.Rd
+++ b/man/BasinObs.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BasinData.R
\docType{data}
\encoding{UTF-8}
@@ -16,7 +16,7 @@ Times series for L0123001 or L0123002 are at the daily time-step for use with da
Times series for L0123003 are at the hourly time-step for use with hourly models such as GR4H.
}
\examples{
-require(airGR)
+ require(airGR)
data(L0123001)
str(BasinObs)
}
diff --git a/man/Calibration.Rd b/man/Calibration.Rd
index f97a41fd..73b052ae 100644
--- a/man/Calibration.Rd
+++ b/man/Calibration.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Calibration.R
\encoding{UTF-8}
\name{Calibration}
@@ -90,7 +90,7 @@ Laurent Coron (June 2014)
\seealso{
\code{\link{Calibration_HBAN}}, \code{\link{Calibration_optim}},
\code{\link{RunModel}}, \code{\link{ErrorCrit}}, \code{\link{TransfoParam}},
- \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
+ \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
\code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}.
}
diff --git a/man/Calibration_HBAN.Rd b/man/Calibration_HBAN.Rd
index 26f14de4..924f74cf 100644
--- a/man/Calibration_HBAN.Rd
+++ b/man/Calibration_HBAN.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Calibration_HBAN.R
\encoding{UTF-8}
\name{Calibration_HBAN}
@@ -42,22 +42,22 @@ Calibration_HBAN(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
\description{
Calibration algorithm which minimises the error criterion. \cr
\cr
-The algorithm is based on a local search procedure.
+The algorithm is based on a local search procedure.
First, a screening is performed using either a rough predefined grid or a list of parameter sets
and then a simple steepest descent local search algorithm is performed.
}
\details{
-A screening is first performed either from a rough predefined grid (considering various initial
+A screening is first performed either from a rough predefined grid (considering various initial
values for each paramete) or from a list of initial parameter sets. \cr
-The best set identified in this screening is then used as a starting point for the steepest
+The best set identified in this screening is then used as a starting point for the steepest
descent local search algorithm. \cr
-For this search, the parameters are used in a transformed version, to obtain uniform
+For this search, the parameters are used in a transformed version, to obtain uniform
variation ranges (and thus a similar pace), while the true ranges might be quite different. \cr
-At each iteration, we start from a parameter set of NParam values (NParam being the number of
-free parameters of the chosen hydrological model) and we determine the 2*NParam-1 new candidates
+At each iteration, we start from a parameter set of NParam values (NParam being the number of
+free parameters of the chosen hydrological model) and we determine the 2*NParam-1 new candidates
by changing one by one the different parameters (+/- pace). \cr
-All these candidates are tested and the best one kept to be the starting point for the next
-iteration. At the end of each iteration, the pace is either increased or decreased to adapt
+All these candidates are tested and the best one kept to be the starting point for the next
+iteration. At the end of each iteration, the pace is either increased or decreased to adapt
the progression speed. A diagonal progress can occasionally be done. \cr
The calibration algorithm stops when the pace becomes too small. \cr
@@ -122,7 +122,7 @@ Michel, C. (1991),
\seealso{
\code{\link{Calibration}}, \code{\link{Calibration_optim}},
\code{\link{RunModel_GR4J}}, \code{\link{TransfoParam_GR4J}}, \code{\link{ErrorCrit_RMSE}},
- \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
+ \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
\code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}.
}
diff --git a/man/Calibration_optim.Rd b/man/Calibration_optim.Rd
index aed6de48..1aed7cdc 100644
--- a/man/Calibration_optim.Rd
+++ b/man/Calibration_optim.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Calibration_optim.R
\encoding{UTF-8}
\name{Calibration_optim}
@@ -38,7 +38,7 @@ Calibration_optim(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
\description{
Calibration algorithm which minimises the error criterion. \cr
\cr
-The algorithm is based on the "optim" function from the "stats" R-package
+The algorithm is based on the "optim" function from the "stats" R-package
(using method="L-BFGS-B", i.e. a local optimization quasi-Newton method).
}
\details{
@@ -98,7 +98,7 @@ Laurent Coron (August 2013)
\seealso{
\code{\link{Calibration}}, \code{\link{Calibration_HBAN}},
\code{\link{RunModel_GR4J}}, \code{\link{TransfoParam_GR4J}}, \code{\link{ErrorCrit_RMSE}},
- \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
+ \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
\code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}.
}
diff --git a/man/CreateCalibOptions.Rd b/man/CreateCalibOptions.Rd
index 6a0676b5..29dc744a 100644
--- a/man/CreateCalibOptions.Rd
+++ b/man/CreateCalibOptions.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateCalibOptions.R
\encoding{UTF-8}
\name{CreateCalibOptions}
@@ -66,7 +66,7 @@ CreateCalibOptions(FUN_MOD, FUN_CALIB = Calibration_HBAN,
Creation of the CalibOptions object required to the Calibration functions.
}
\details{
-Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not included in
+Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not included in
the package must create their own CalibOptions object accordingly.
}
\examples{
diff --git a/man/CreateInputsCrit.Rd b/man/CreateInputsCrit.Rd
index fd7176cc..50e84cfd 100644
--- a/man/CreateInputsCrit.Rd
+++ b/man/CreateInputsCrit.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateInputsCrit.R
\encoding{UTF-8}
\name{CreateInputsCrit}
@@ -39,7 +39,7 @@ CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions, Qobs, BoolCrit = NULL,
Creation of the InputsCrit object required to the ErrorCrit functions.
}
\details{
-Users wanting to use FUN_CRIT functions that are not included in
+Users wanting to use FUN_CRIT functions that are not included in
the package must create their own InputsCrit object accordingly.
}
\examples{
diff --git a/man/CreateInputsModel.Rd b/man/CreateInputsModel.Rd
index c741da3f..8f3637f8 100644
--- a/man/CreateInputsModel.Rd
+++ b/man/CreateInputsModel.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateInputsModel.R
\encoding{UTF-8}
\name{CreateInputsModel}
@@ -47,7 +47,7 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
Creation of the InputsModel object required to the RunModel functions.
}
\details{
-Users wanting to use FUN_MOD functions that are not included in
+Users wanting to use FUN_MOD functions that are not included in
the package must create their own InputsModel object accordingly.
}
\examples{
diff --git a/man/CreateRunOptions.Rd b/man/CreateRunOptions.Rd
index 3ab14bc5..84963d84 100644
--- a/man/CreateRunOptions.Rd
+++ b/man/CreateRunOptions.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateRunOptions.R
\encoding{UTF-8}
\name{CreateRunOptions}
@@ -50,7 +50,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run,
Creation of the RunOptions object required to the RunModel functions.
}
\details{
-Users wanting to use FUN_MOD functions that are not included in
+Users wanting to use FUN_MOD functions that are not included in
the package must create their own RunOptions object accordingly.
##### Initialisation options #####
@@ -63,7 +63,7 @@ A default configuration is used for initialisation if these vectors are not defi
(1) Default initialisation options:
\itemize{
-\item \emph{IndPeriod_WarmUp} default setting ensures a one-year warm-up using the time-steps preceding the \emph{IndPeriod_Run}.
+\item \emph{IndPeriod_WarmUp} default setting ensures a one-year warm-up using the time-steps preceding the \emph{IndPeriod_Run}.
The actual length of this warm-up might be shorter depending on data availability (no missing value being allowed on model input series).
\item \emph{IniStates} and \emph{IniResLevels} are automatically set to initialise all the model states at 0, except for the production and routing stores which are initialised at 50\% of their capacity. This initialisation is made at the very beginning of the model call (i.e. at the beginning of \emph{IndPeriod_WarmUp} or at the beginning of IndPeriod_Run if the warm-up period is disabled).
diff --git a/man/DataAltiExtrapolation_HBAN.Rd b/man/DataAltiExtrapolation_HBAN.Rd
index e2ad3cc3..1d71705c 100644
--- a/man/DataAltiExtrapolation_HBAN.Rd
+++ b/man/DataAltiExtrapolation_HBAN.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/DataAltiExtrapolation_HBAN.R
\encoding{UTF-8}
\name{DataAltiExtrapolation_HBAN}
@@ -29,7 +29,7 @@ DataAltiExtrapolation_HBAN(DatesR, Precip, TempMean, TempMin = NULL,
}
\value{
list containing the extrapolated series of precip. and air temp. on each elevation layer
- \tabular{ll}{
+ \tabular{ll}{
\emph{$LayerPrecip } \tab [list] list of time series of daily precipitation (layer average) [mm] \cr
\emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [degC] \cr
\emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [degC] \cr
@@ -42,7 +42,7 @@ list containing the extrapolated series of precip. and air temp. on each elevati
Function which extrapolates the precipitation and air temperature series for different elevation layers (method from Valery, 2010).
}
\details{
-Elevation layers of equal surface are created the 101 elevation quantiles (\emph{HypsoData})
+Elevation layers of equal surface are created the 101 elevation quantiles (\emph{HypsoData})
and the number requested elevation layers (\emph{NLayers}). \cr
Forcing data (precipitation and air temperature) are extrapolated using gradients from Valery (2010).
(e.g. gradP=0.0004 [m-1] for France and gradT=0.434 [degreC/100m] for January, 1st). \cr
@@ -52,10 +52,10 @@ This function is used by the \emph{CreateInputsModel} function. \cr
Laurent Coron, Pierre Brigode (June 2014)
}
\references{
-Turcotte, R., L.-G. Fortin, V. Fortin, J.-P. Fortin and J.-P. Villeneuve (2007),
- Operational analysis of the spatial distribution and the temporal evolution of the snowpack water equivalent
+Turcotte, R., L.-G. Fortin, V. Fortin, J.-P. Fortin and J.-P. Villeneuve (2007),
+ Operational analysis of the spatial distribution and the temporal evolution of the snowpack water equivalent
in southern Quebec, Canada, Nordic Hydrology, 38(3), 211, doi:10.2166/nh.2007.009. \cr
- Valéry, A. (2010), Modélisation précipitations-débit sous influence nivale ? : Elaboration d'un module neige
+ Valéry, A. (2010), Modélisation précipitations-débit sous influence nivale ? : Elaboration d'un module neige
et évaluation sur 380 bassins versants, PhD thesis (in french), AgroParisTech, Paris, France. \cr
USACE (1956), Snow Hydrology, pp. 437, U.S. Army Coprs of Engineers (USACE) North Pacific Division, Portland, Oregon, USA.
}
diff --git a/man/ErrorCrit.Rd b/man/ErrorCrit.Rd
index 3a09b9d0..8db84a90 100644
--- a/man/ErrorCrit.Rd
+++ b/man/ErrorCrit.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit.R
\encoding{UTF-8}
\name{ErrorCrit}
diff --git a/man/ErrorCrit_KGE.Rd b/man/ErrorCrit_KGE.Rd
index 31574db4..51a677ac 100644
--- a/man/ErrorCrit_KGE.Rd
+++ b/man/ErrorCrit_KGE.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_KGE.R
\encoding{UTF-8}
\name{ErrorCrit_KGE}
@@ -30,8 +30,8 @@ ErrorCrit_KGE(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the KGE formula proposed by Gupta et al. (2009).
}
\details{
-In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
-the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
+In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
+the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
@@ -41,7 +41,7 @@ the use of the function for model calibration: the product CritValue*Multiplier
Laurent Coron (June 2014)
}
\references{
-Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
+Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
Decomposition of the mean squared error and NSE performance criteria: Implications
for improving hydrological modelling, Journal of Hydrology, 377(1-2), 80-91, doi:10.1016/j.jhydrol.2009.08.003. \cr
}
diff --git a/man/ErrorCrit_KGE2.Rd b/man/ErrorCrit_KGE2.Rd
index 58369b76..0631d5f7 100644
--- a/man/ErrorCrit_KGE2.Rd
+++ b/man/ErrorCrit_KGE2.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_KGE2.R
\encoding{UTF-8}
\name{ErrorCrit_KGE2}
@@ -30,8 +30,8 @@ ErrorCrit_KGE2(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the KGE' formula proposed by Kling et al. (2012).
}
\details{
-In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
-the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
+In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
+the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
@@ -41,10 +41,10 @@ the use of the function for model calibration: the product CritValue*Multiplier
Laurent Coron (June 2014)
}
\references{
-Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
+Gupta, H. V., Kling, H., Yilmaz, K. K. and Martinez, G. F. (2009),
Decomposition of the mean squared error and NSE performance criteria: Implications
for improving hydrological modelling, Journal of Hydrology, 377(1-2), 80-91, doi:10.1016/j.jhydrol.2009.08.003. \cr
- Kling, H., Fuchs, M. and Paulin, M. (2012),
+ Kling, H., Fuchs, M. and Paulin, M. (2012),
Runoff conditions in the upper Danube basin under an ensemble of climate change scenarios,
Journal of Hydrology, 424-425, 264-277, doi:10.1016/j.jhydrol.2012.01.011.
}
diff --git a/man/ErrorCrit_NSE.Rd b/man/ErrorCrit_NSE.Rd
index 29c27b8e..f12ae8e4 100644
--- a/man/ErrorCrit_NSE.Rd
+++ b/man/ErrorCrit_NSE.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_NSE.R
\encoding{UTF-8}
\name{ErrorCrit_NSE}
@@ -28,8 +28,8 @@ ErrorCrit_NSE(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the NSE formula proposed by Nash & Sutcliffe (1970).
}
\details{
-In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
-the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
+In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
+the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
@@ -39,7 +39,7 @@ the use of the function for model calibration: the product CritValue*Multiplier
Laurent Coron (June 2014)
}
\references{
-Nash, J.E. and Sutcliffe, J.V. (1970),
+Nash, J.E. and Sutcliffe, J.V. (1970),
River flow forecasting through conceptual models part 1.
A discussion of principles, Journal of Hydrology, 10(3), 282-290, doi:10.1016/0022-1694(70)90255-6. \cr
}
diff --git a/man/ErrorCrit_RMSE.Rd b/man/ErrorCrit_RMSE.Rd
index 27164860..fdc8194b 100644
--- a/man/ErrorCrit_RMSE.Rd
+++ b/man/ErrorCrit_RMSE.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_RMSE.R
\encoding{UTF-8}
\name{ErrorCrit_RMSE}
@@ -28,8 +28,8 @@ ErrorCrit_RMSE(InputsCrit, OutputsModel, quiet = FALSE)
Function which computes an error criterion based on the root mean square error (RMSE).
}
\details{
-In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
-the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
+In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
+the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
}
\examples{
diff --git a/man/PEdaily_Oudin.Rd b/man/PEdaily_Oudin.Rd
index ffdc7635..1bcc308c 100644
--- a/man/PEdaily_Oudin.Rd
+++ b/man/PEdaily_Oudin.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/PEdaily_Oudin.R
\encoding{UTF-8}
\name{PEdaily_Oudin}
@@ -21,7 +21,7 @@ PEdaily_Oudin(JD, Temp, LatRad)
Function which computes daily PE using the formula from Oudin et al. (2005).
}
\examples{
-require(airGR)
+ require(airGR)
data(L0123001)
PotEvap <- PEdaily_Oudin(JD=as.POSIXlt(BasinObs$DatesR)$yday,Temp=BasinObs$T,LatRad=0.8)
}
@@ -30,8 +30,8 @@ Laurent Coron (December 2013)
}
\references{
Oudin, L., F. Hervieu, C. Michel, C. Perrin, V. Andréassian, F. Anctil and C. Loumagne (2005),
- Which potential evapotranspiration input for a lumped rainfall-runoff model?: Part 2-Towards a
- simple and efficient potential evapotranspiration model for rainfall-runoff modelling, Journal of Hydrology,
+ Which potential evapotranspiration input for a lumped rainfall-runoff model?: Part 2-Towards a
+ simple and efficient potential evapotranspiration model for rainfall-runoff modelling, Journal of Hydrology,
303(1-4), 290-306, doi:10.1016/j.jhydrol.2004.08.026.
}
diff --git a/man/RunModel.Rd b/man/RunModel.Rd
index c814a9e4..608cf333 100644
--- a/man/RunModel.Rd
+++ b/man/RunModel.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel.R
\encoding{UTF-8}
\name{RunModel}
diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd
index ec08a968..d6ec2d39 100644
--- a/man/RunModel_CemaNeige.Rd
+++ b/man/RunModel_CemaNeige.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeige.R
\encoding{UTF-8}
\name{RunModel_CemaNeige}
@@ -13,14 +13,14 @@ RunModel_CemaNeige(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 2 parameters
-\tabular{ll}{
+\tabular{ll}{
CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
@@ -32,7 +32,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & degC] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -73,11 +73,11 @@ plot_OutputsModel(OutputsModel=OutputsModel)
Laurent Coron (January 2014)
}
\references{
-Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
+Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
+ Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd
index 33a4af32..5dc1a968 100644
--- a/man/RunModel_CemaNeigeGR4J.Rd
+++ b/man/RunModel_CemaNeigeGR4J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR4J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR4J}
@@ -13,7 +13,7 @@ RunModel_CemaNeigeGR4J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 6 parameters
-\tabular{ll}{
+\tabular{ll}{
GR4J X1 \tab production store capacity [mm] \cr
GR4J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR4J X3 \tab routing store capacity [mm] \cr
@@ -23,8 +23,8 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
@@ -50,7 +50,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & HU levels [mm], CemaNeige states [mm & degC] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -97,14 +97,14 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
-Perrin, C., C. Michel and V. Andréassian (2003),
- Improvement of a parsimonious model for streamflow simulation,
+Perrin, C., C. Michel and V. Andréassian (2003),
+ Improvement of a parsimonious model for streamflow simulation,
Journal of Hydrology, 279(1-4), 275-289, doi:10.1016/S0022-1694(03)00225-7. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
+ Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
+ Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd
index 1d0cf524..2c114c41 100644
--- a/man/RunModel_CemaNeigeGR5J.Rd
+++ b/man/RunModel_CemaNeigeGR5J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR5J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR5J}
@@ -13,7 +13,7 @@ RunModel_CemaNeigeGR5J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 7 parameters
-\tabular{ll}{
+\tabular{ll}{
GR5J X1 \tab production store capacity [mm] \cr
GR5J X2 \tab intercatchment exchange coefficient 1 [mm/d] \cr
GR5J X3 \tab routing store capacity [mm] \cr
@@ -24,8 +24,8 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
@@ -51,7 +51,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & HU levels [mm], CemaNeige states [mm & degC] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -98,16 +98,16 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
-Le Moine, N. (2008), Le bassin versant de surface vu par le souterrain : une voie d'amélioration des performances
+Le Moine, N. (2008), Le bassin versant de surface vu par le souterrain : une voie d'amélioration des performances
et du réalisme des modèles pluie-débit ?, PhD thesis (french), UPMC, Paris, France. \cr
- Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
- A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
+ Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
+ A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
+ Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
+ Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd
index cbf4f2cb..755866a9 100644
--- a/man/RunModel_CemaNeigeGR6J.Rd
+++ b/man/RunModel_CemaNeigeGR6J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR6J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR6J}
@@ -13,7 +13,7 @@ RunModel_CemaNeigeGR6J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 8 parameters
-\tabular{ll}{
+\tabular{ll}{
GR6J X1 \tab production store capacity [mm] \cr
GR6J X2 \tab intercatchment exchange coefficient 1 [mm/d] \cr
GR6J X3 \tab routing store capacity [mm] \cr
@@ -25,8 +25,8 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
@@ -54,7 +54,7 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & HU levels [mm], CemaNeige states [mm & degC] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -101,14 +101,14 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
-Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
- A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
+Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
+ A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
+ Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine?
Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
- Valéry, A., V. Andréassian and C. Perrin (2014),
- "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
+ Valéry, A., V. Andréassian and C. Perrin (2014),
+ "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine?
Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
\seealso{
diff --git a/man/RunModel_GR1A.Rd b/man/RunModel_GR1A.Rd
index 17644fc1..69a1952d 100644
--- a/man/RunModel_GR1A.Rd
+++ b/man/RunModel_GR1A.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR1A.R
\encoding{UTF-8}
\name{RunModel_GR1A}
@@ -13,18 +13,18 @@ RunModel_GR1A(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
-\tabular{ll}{
+\tabular{ll}{
GR1A X1 \tab model parameter [mm] \cr
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/h] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -80,7 +80,7 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (March 2015)
}
\references{
-Mouelhi S. (2003),
+Mouelhi S. (2003),
Vers une chaîne cohérente de modèles pluie-débit conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et journalier,
PhD thesis (in French), ENGREF, Cemagref Antony, France. \cr
}
diff --git a/man/RunModel_GR2M.Rd b/man/RunModel_GR2M.Rd
index 5103fc1e..f22cdbd8 100644
--- a/man/RunModel_GR2M.Rd
+++ b/man/RunModel_GR2M.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR2M.R
\encoding{UTF-8}
\name{RunModel_GR2M}
@@ -13,14 +13,14 @@ RunModel_GR2M(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
-\tabular{ll}{
+\tabular{ll}{
GR2M X1 \tab production store capacity [mm] \cr
GR2M X2 \tab groundwater exchange coefficient [mm/month] \cr
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/h] \cr
@@ -37,7 +37,7 @@ GR2M X2 \tab groundwater exchange coefficient [mm/month] \cr
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -91,7 +91,7 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (March 2015)
}
\references{
-Mouelhi S. (2003),
+Mouelhi S. (2003),
Vers une chaîne cohérente de modèles pluie-débit conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et journalier,
PhD thesis (in French), ENGREF, Cemagref Antony, France. \cr
Mouelhi, S., C. Michel, C. Perrin and V. Andréassian (2006),
diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd
index b9d7a4a7..52132060 100644
--- a/man/RunModel_GR4H.Rd
+++ b/man/RunModel_GR4H.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR4H.R
\encoding{UTF-8}
\name{RunModel_GR4H}
@@ -13,7 +13,7 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
-\tabular{ll}{
+\tabular{ll}{
GR4H X1 \tab production store capacity [mm] \cr
GR4H X2 \tab groundwater exchange coefficient [mm/h] \cr
GR4H X3 \tab routing store capacity [mm] \cr
@@ -21,8 +21,8 @@ GR4H X4 \tab unit hydrograph time constant [h]
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/h] \cr
@@ -39,7 +39,7 @@ GR4H X4 \tab unit hydrograph time constant [h]
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -83,8 +83,8 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (July 2014)
}
\references{
-Mathevet, T. (2005),
- Quels modèles pluie-débit globaux pour le pas de temps horaire ? Développement empirique et comparaison de modèles sur un large échantillon de bassins versants,
+Mathevet, T. (2005),
+ Quels modèles pluie-débit globaux pour le pas de temps horaire ? Développement empirique et comparaison de modèles sur un large échantillon de bassins versants,
PhD thesis (in French), ENGREF - Cemagref (Antony), Paris, France.
}
\seealso{
diff --git a/man/RunModel_GR4J.Rd b/man/RunModel_GR4J.Rd
index 3e79c8ab..f3f39373 100644
--- a/man/RunModel_GR4J.Rd
+++ b/man/RunModel_GR4J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR4J.R
\encoding{UTF-8}
\name{RunModel_GR4J}
@@ -13,7 +13,7 @@ RunModel_GR4J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
-\tabular{ll}{
+\tabular{ll}{
GR4J X1 \tab production store capacity [mm] \cr
GR4J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR4J X3 \tab routing store capacity [mm] \cr
@@ -21,8 +21,8 @@ GR4J X4 \tab unit hydrograph time constant [d]
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
@@ -39,7 +39,7 @@ GR4J X4 \tab unit hydrograph time constant [d]
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -83,8 +83,8 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
-Perrin, C., C. Michel and V. Andréassian (2003),
- Improvement of a parsimonious model for streamflow simulation,
+Perrin, C., C. Michel and V. Andréassian (2003),
+ Improvement of a parsimonious model for streamflow simulation,
Journal of Hydrology, 279(1-4), 275-289, doi:10.1016/S0022-1694(03)00225-7.
}
\seealso{
diff --git a/man/RunModel_GR5J.Rd b/man/RunModel_GR5J.Rd
index a67da9d6..99510f4e 100644
--- a/man/RunModel_GR5J.Rd
+++ b/man/RunModel_GR5J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR5J.R
\encoding{UTF-8}
\name{RunModel_GR5J}
@@ -13,7 +13,7 @@ RunModel_GR5J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 5 parameters
-\tabular{ll}{
+\tabular{ll}{
GR5J X1 \tab production store capacity [mm] \cr
GR5J X2 \tab intercatchment exchange coefficient 1 [mm/d] \cr
GR5J X3 \tab routing store capacity [mm] \cr
@@ -22,8 +22,8 @@ GR5J X5 \tab intercatchment exchange coefficient 2 [-]
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
@@ -40,7 +40,7 @@ GR5J X5 \tab intercatchment exchange coefficient 2 [-]
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -86,8 +86,8 @@ Laurent Coron (December 2013)
\references{
Le Moine, N. (2008), Le bassin versant de surface vu par le souterrain : une voie d'amélioration des performances
et du réalisme des modèles pluie-débit ?, PhD thesis (french), UPMC, Paris, France. \cr
- Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet, and V. Andréassian (2011),
- A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
+ Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet, and V. Andréassian (2011),
+ A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
}
\seealso{
diff --git a/man/RunModel_GR6J.Rd b/man/RunModel_GR6J.Rd
index 4fe20c62..5e075d97 100644
--- a/man/RunModel_GR6J.Rd
+++ b/man/RunModel_GR6J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_GR6J.R
\encoding{UTF-8}
\name{RunModel_GR6J}
@@ -13,7 +13,7 @@ RunModel_GR6J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 6 parameters
-\tabular{ll}{
+\tabular{ll}{
GR6J X1 \tab production store capacity [mm] \cr
GR6J X2 \tab intercatchment exchange coefficient 1 [mm/d] \cr
GR6J X3 \tab routing store capacity [mm] \cr
@@ -23,8 +23,8 @@ GR6J X6 \tab coefficient for emptying exponential store [-]
}}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
+[list] list containing the function outputs organised as follows:
+ \tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
@@ -43,7 +43,7 @@ GR6J X6 \tab coefficient for emptying exponential store [-]
\emph{$QD } \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
- }
+ }
(refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
@@ -87,8 +87,8 @@ cat(paste(" Crit ",OutputsCrit$CritName," ",round(OutputsCrit$CritValue,4),"\
Laurent Coron (December 2013)
}
\references{
-Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
- A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
+Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011),
+ A downward structural sensitivity analysis of hydrological models to improve low-flow simulation,
Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
}
\seealso{
diff --git a/man/SeriesAggreg.Rd b/man/SeriesAggreg.Rd
index dc1e84fe..5cb9ea09 100644
--- a/man/SeriesAggreg.Rd
+++ b/man/SeriesAggreg.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/SeriesAggreg.R
\encoding{UTF-8}
\name{SeriesAggreg}
diff --git a/man/TransfoParam.Rd b/man/TransfoParam.Rd
index 8124b307..2833b0e5 100644
--- a/man/TransfoParam.Rd
+++ b/man/TransfoParam.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam.R
\encoding{UTF-8}
\name{TransfoParam}
diff --git a/man/TransfoParam_CemaNeige.Rd b/man/TransfoParam_CemaNeige.Rd
index 0dd630f4..3be2eb83 100644
--- a/man/TransfoParam_CemaNeige.Rd
+++ b/man/TransfoParam_CemaNeige.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam_CemaNeige.R
\encoding{UTF-8}
\name{TransfoParam_CemaNeige}
diff --git a/man/TransfoParam_GR1A.Rd b/man/TransfoParam_GR1A.Rd
index d9067e79..994aeae6 100644
--- a/man/TransfoParam_GR1A.Rd
+++ b/man/TransfoParam_GR1A.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam_GR1A.R
\encoding{UTF-8}
\name{TransfoParam_GR1A}
diff --git a/man/TransfoParam_GR2M.Rd b/man/TransfoParam_GR2M.Rd
index d031bfa4..2444ee17 100644
--- a/man/TransfoParam_GR2M.Rd
+++ b/man/TransfoParam_GR2M.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam_GR2M.R
\encoding{UTF-8}
\name{TransfoParam_GR2M}
diff --git a/man/TransfoParam_GR4H.Rd b/man/TransfoParam_GR4H.Rd
index 9529ebc3..588c361e 100644
--- a/man/TransfoParam_GR4H.Rd
+++ b/man/TransfoParam_GR4H.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam_GR4H.R
\encoding{UTF-8}
\name{TransfoParam_GR4H}
diff --git a/man/TransfoParam_GR4J.Rd b/man/TransfoParam_GR4J.Rd
index 329af790..a404e7b1 100644
--- a/man/TransfoParam_GR4J.Rd
+++ b/man/TransfoParam_GR4J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam_GR4J.R
\encoding{UTF-8}
\name{TransfoParam_GR4J}
diff --git a/man/TransfoParam_GR5J.Rd b/man/TransfoParam_GR5J.Rd
index 667851df..61db77b9 100644
--- a/man/TransfoParam_GR5J.Rd
+++ b/man/TransfoParam_GR5J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam_GR5J.R
\encoding{UTF-8}
\name{TransfoParam_GR5J}
diff --git a/man/TransfoParam_GR6J.Rd b/man/TransfoParam_GR6J.Rd
index a8e761e6..7ed7b7a4 100644
--- a/man/TransfoParam_GR6J.Rd
+++ b/man/TransfoParam_GR6J.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TransfoParam_GR6J.R
\encoding{UTF-8}
\name{TransfoParam_GR6J}
diff --git a/man/airGR.Rd b/man/airGR.Rd
index e5aa8c4b..27b860a4 100644
--- a/man/airGR.Rd
+++ b/man/airGR.Rd
@@ -58,8 +58,8 @@ To learn how to use the functions from the airGR package, it is recommended to f
\tabular{ll}{
Package: \tab airGR\cr
Type: \tab Package\cr
-Version: \tab 0.8.1.0\cr
-Date: \tab 2015-10-27\cr
+Version: \tab 0.8.1.1\cr
+Date: \tab 2015-11-26\cr
License: \tab GPL-2\cr
}
}
diff --git a/man/plot_OutputsModel.Rd b/man/plot_OutputsModel.Rd
index be75d308..ea88a1fd 100644
--- a/man/plot_OutputsModel.Rd
+++ b/man/plot_OutputsModel.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_OutputsModel.R
\encoding{UTF-8}
\name{plot_OutputsModel}
--
GitLab