v1.1.3.1 UPDATE: CreatInputsCrit doc take into account SCA, SWE and SD observations

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.1.3.0
+Version: 1.1.3.1
 Date: 2019-02-21
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),

NEWS.rmd

@@ -13,7 +13,7 @@ output:
 
 
 
-### 1.1.3.0 Release Notes (2019-02-21)
+### 1.1.3.1 Release Notes (2019-02-21)
 
 
 

man/CreateInputsCrit.Rd

@@ -10,7 +10,7 @@
 
 \usage{
 CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions,
-  Qobs, obs, varObs = "Qobs", BoolCrit = NULL,
+  Qobs, obs, varObs = "Q", BoolCrit = NULL,
   transfo = "", weights = NULL,
   Ind_zeroes = NULL, epsilon = NULL,
   warnings = TRUE, verbose = TRUE)
@@ -28,7 +28,7 @@ CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions,
 
 \item{obs}{[numeric (atomic or list)] series of observed variable (typically discharge [mm/time step])}
 
-\item{varObs}{(optional) [character (atomic or list)] names of the observed variable (\code{"Qobs"} by default])}
+\item{varObs}{(optional) [character (atomic or list)] names of the observed variable (\code{"Q"} by default, or one of \code{"SCA"}, \code{"SWE"}, \code{"SD"}])}
 
 \item{BoolCrit}{(optional) [boolean (atomic or list)] boolean (the same length as \code{obs}) giving the time steps to consider in the computation (all time steps are considered by default)}
 
@@ -51,7 +51,7 @@ CreateInputsCrit(FUN_CRIT, InputsModel, RunOptions,
   \tabular{ll}{
     \emph{$FUN_CRIT  } \tab [function] error criterion function (e.g. \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}}) \cr
     \emph{$obs       } \tab [numeric] series of observed variable (typically discharges [mm/time step]) \cr
-    \emph{$varObs    } \tab [character] names of the observed variable (\code{"Qobs"} by default]) \cr
+    \emph{$varObs    } \tab [character] names of the observed variable (\code{"Q"} by default]) \cr
     \emph{$BoolCrit  } \tab [boolean] boolean giving the time steps considered in the computation \cr
     \emph{$transfo   } \tab [character] name of the transformation (e.g. \code{""}, \code{"sqrt"}, \code{"log"}, \code{"inv"}, \code{"sort"}) \cr
     \emph{$epsilon   } \tab [numeric] small value to add to all Qobs and Qsim (useful when \code{"log"} or \code{"inv"} transformations are used) [same unit as \code{obs}] \cr
@@ -106,8 +106,8 @@ OutputsModel <- RunModel_GR4J(InputsModel = InputsModel, RunOptions = RunOptions
 InputsCritSingle <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE,
                                      InputsModel = InputsModel, RunOptions = RunOptions,
                                      obs = list(BasinObs$Qmm[Ind_Run]),
-                                     varObs = "Qobs", transfo = "",
-                                     weight = NULL)
+                                     varObs = "Q", transfo = "",
+                                     weights = NULL)
 str(InputsCritSingle)
 invisible(ErrorCrit(InputsCrit = InputsCritSingle, OutputsModel = OutputsModel))
 
@@ -115,8 +115,8 @@ invisible(ErrorCrit(InputsCrit = InputsCritSingle, OutputsModel = OutputsModel))
 InputsCritMulti <- CreateInputsCrit(FUN_CRIT = list(ErrorCrit_RMSE, ErrorCrit_NSE),
                                     InputsModel = InputsModel, RunOptions = RunOptions,
                                     obs = list(BasinObs$Qmm[Ind_Run], BasinObs$Qmm[Ind_Run]),
-                                    varObs = list("Qobs", "Qobs"), transfo = list("", "sqrt"),
-                                    weight = NULL)
+                                    varObs = list("Q", "Q"), transfo = list("", "sqrt"),
+                                    weights = NULL)
 str(InputsCritMulti)                                         
 invisible(ErrorCrit(InputsCrit = InputsCritMulti, OutputsModel = OutputsModel))
 
@@ -125,8 +125,8 @@ invisible(ErrorCrit(InputsCrit = InputsCritMulti, OutputsModel = OutputsModel))
 InputsCritCompo <- CreateInputsCrit(FUN_CRIT = list(ErrorCrit_NSE, ErrorCrit_NSE),
                                     InputsModel = InputsModel, RunOptions = RunOptions,
                                     obs = list(BasinObs$Qmm[Ind_Run], BasinObs$Qmm[Ind_Run]),
-                                    varObs = list("Qobs", "Qobs"), transfo = list("", "log"),
-                                    weight = list(0.4, 0.6))
+                                    varObs = list("Q", "Q"), transfo = list("", "log"),
+                                    weights = list(0.4, 0.6))
 str(InputsCritCompo)                                         
 invisible(ErrorCrit(InputsCrit = InputsCritCompo, OutputsModel = OutputsModel))
 }