v1.0.5.3 DataAltiExtrapolation_Valery() and CreateInputsModel() admit a...

v1.0.5.3 DataAltiExtrapolation_Valery() and CreateInputsModel() admit a PreciScale argument which allows to rescale precipitation interpolated on the elevation layers when CemaNeige is used #4521

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR hydrological models for precipitation-runoff modelling
-Version: 1.0.5.2
+Version: 1.0.5.3
 Date: 2017-01-19
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl")),

R/CreateInputsModel.R

-CreateInputsModel <- function(FUN_MOD,DatesR,Precip,PotEvap=NULL,TempMean=NULL,TempMin=NULL,TempMax=NULL,ZInputs=NULL,HypsoData=NULL,NLayers=5, verbose = TRUE) {
+CreateInputsModel <- function(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL, TempMean = NULL, TempMin = NULL, TempMax = NULL, ZInputs = NULL, HypsoData = NULL, NLayers = 5, verbose = TRUE) {
 
   ObjectClass <- NULL
 
@@ -126,7 +126,7 @@ CreateInputsModel <- function(FUN_MOD,DatesR,Precip,PotEvap=NULL,TempMean=NULL,T
 
   ##DataAltiExtrapolation_Valery
     if("CemaNeige" %in% ObjectClass) {
-      RESULT <- DataAltiExtrapolation_Valery(DatesR=DatesR,Precip=Precip,TempMean=TempMean,TempMin=TempMin,TempMax=TempMax,ZInputs=ZInputs,HypsoData=HypsoData,NLayers=NLayers, verbose = verbose);
+      RESULT <- DataAltiExtrapolation_Valery(DatesR = DatesR, Precip = Precip, PrecipScale = PrecipScale, TempMean = TempMean, TempMin = TempMin, TempMax = TempMax, ZInputs = ZInputs, HypsoData = HypsoData, NLayers = NLayers, verbose = verbose)
       if(verbose) {
         if(NLayers == 1) {
           message("\t Input series were successfully created on 1 elevation layer for use by CemaNeige")

inst/CITATION

@@ -18,13 +18,13 @@ citEntry(entry="Manual",
     author = personList(as.person("L. Coron"), as.person("C. Perrin"), as.person("C. Michel")),
 	journal = "R News",
   	year = "2017",
-    note = "R package version 1.0.5.2",
+    note = "R package version 1.0.5.3",
     url = "https://webgr.irstea.fr/airGR/?lang=en",
         textVersion = 
         paste("Coron, L., Perrin, C. and Michel, C.",
 			  "(2017).", 
               "airGR: Suite of GR hydrological models for precipitation-runoff modelling.",
-              "R package version 1.0.5.2.",
+              "R package version 1.0.5.3.",
               "https://webgr.irstea.fr/airGR/?lang=en.",
               sep = " ")
          )

man/CreateInputsModel.Rd

@@ -3,8 +3,8 @@
 \alias{CreateInputsModel}
 \title{Creation of the InputsModel object required to the RunModel functions}
 \usage{
-CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
-  TempMin = NULL, TempMax = NULL, ZInputs = NULL, HypsoData = NULL,
+CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
+  TempMean = NULL, TempMin = NULL, TempMax = NULL, ZInputs = NULL, HypsoData = NULL,
   NLayers = 5, verbose = TRUE)
 }
 \arguments{
@@ -14,6 +14,8 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
 
 \item{Precip}{[numeric] time series of total precipitation (catchment average) [mm], required to create the GR model and CemaNeige module inputs}
 
+\item{PrecipScale}{(optional) [boolean] indicating if the mean of the precipitation interpolated on the elevation layers must be kept or not, required to create CemaNeige module inputs, default = \code{TRUE} (the mean of the precipitation is kept to the original value)}
+
 \item{PotEvap}{[numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}
 
 \item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige module inputs}

man/DataAltiExtrapolation_Valery.Rd

@@ -3,14 +3,17 @@
 \alias{DataAltiExtrapolation_Valery}
 \title{Altitudinal extrapolation of precipitation and temperature series described by A. Valery}
 \usage{
-DataAltiExtrapolation_Valery(DatesR, Precip, TempMean, TempMin = NULL,
-  TempMax = NULL, ZInputs, HypsoData, NLayers, verbose = TRUE)
+DataAltiExtrapolation_Valery(DatesR, Precip, PrecipScale = TRUE,
+  TempMean, TempMin = NULL, TempMax = NULL,
+  ZInputs, HypsoData, NLayers, verbose = TRUE)
 }
 \arguments{
 \item{DatesR}{[POSIXt] vector of dates}
 
 \item{Precip}{[numeric] time series of daily total precipitation (catchment average) [mm]}
 
+\item{PrecipScale}{(optional) [boolean] indicating if the mean of the precipitation interpolated on the elevation layers must be kept or not, required to create CemaNeige module inputs, default = \code{TRUE} (the mean of the precipitation is kept to the original value)}
+
 \item{TempMean}{[numeric] time series of daily mean air temperature [°C]}
 
 \item{TempMin}{(optional) [numeric] time series of daily min air temperature [°C]}