v1.2.9.0 NEW: FUN_* arguments can be a character of the function name

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.2.8.11
+Version: 1.2.9.0
 Date: 2019-03-12
 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.2.8.11 Release Notes (2019-03-12) 
+### 1.2.9.0 Release Notes (2019-03-12) 
 
 
 
@@ -60,6 +60,8 @@ output:
 
 - It is now possible to be redirected on the documantation about <code>plot.OutputsModel()</code> with <code>?plot</code>.
 
+- It is now possible to use a character vector the function name (in addition to function objects) in all <code>FUN_&#42;</code> arguments of the following functions: <code>Calibration()</code>, <code>Calibration_Michel()</code>, <code>CreateCalibOptions()</code>, <code>CreateIniStates()</code>, <code>CreateIniStates()</code>, <code>CreateInputsCrit()</code>, <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>ErrorCrit()</code>, <code>RunModel()</code> and <code>TransfoParam()</code>.
+
 
 #### Minor user-visible changes
 

R/Calibration.R

 Calibration <- function(InputsModel, RunOptions, InputsCrit, CalibOptions,
                         FUN_MOD, FUN_CRIT, FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL,
                         verbose = TRUE) {
-  if (! is.function(FUN_CALIB)) {
-    stop("'FUN_CALIB' must be a function")
-  }
+  FUN_MOD   <- match.fun(FUN_MOD)
+  FUN_CRIT  <- match.fun(FUN_CRIT)
+  FUN_CALIB <- match.fun(FUN_CALIB)
+  FUN_TRANSFO <- match.fun(FUN_TRANSFO)
   return(FUN_CALIB(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD, FUN_CRIT, FUN_TRANSFO, verbose = verbose))
 }
 

R/Calibration_Michel.R

@@ -2,6 +2,13 @@ Calibration_Michel <- function(InputsModel, RunOptions, InputsCrit, CalibOptions
                                FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE) {
   
   
+  FUN_MOD     <- match.fun(FUN_MOD)
+  FUN_CRIT    <- match.fun(FUN_CRIT)
+  if (!is.null(FUN_TRANSFO)) {
+    FUN_TRANSFO <- match.fun(FUN_TRANSFO)
+  }
+  
+  
   ##_____Arguments_check_____________________________________________________________________
   if (!inherits(InputsModel, "InputsModel")) {
     stop("InputsModel must be of class 'InputsModel'")

R/CreateCalibOptions.R

-CreateCalibOptions <-
-  function(FUN_MOD,
-           FUN_CALIB = Calibration_Michel,
-           FUN_TRANSFO = NULL,
-           FixedParam = NULL,
-           SearchRanges = NULL,
-           StartParamList = NULL,
-           StartParamDistrib = NULL) {
-    
-    ObjectClass <- NULL
+CreateCalibOptions <- function(FUN_MOD,
+                               FUN_CALIB = Calibration_Michel,
+                               FUN_TRANSFO = NULL,
+                               FixedParam = NULL,
+                               SearchRanges = NULL,
+                               StartParamList = NULL,
+                               StartParamDistrib = NULL) {
+  
+  ObjectClass <- NULL
     
+    FUN_MOD     <- match.fun(FUN_MOD)
+    FUN_CALIB   <- match.fun(FUN_CALIB)
+    FUN_TRANSFO <- match.fun(FUN_TRANSFO)
     
     ##check_FUN_MOD
     BOOL <- FALSE

R/CreateIniStates.R

@@ -11,6 +11,7 @@ CreateIniStates <- function(FUN_MOD, InputsModel,
   UH1n <- 20L
   UH2n <- UH1n * 2L
   
+  FUN_MOD <- match.fun(FUN_MOD)
   
   ## check FUN_MOD
   BOOL <- FALSE

R/CreateInputsCrit.R

@@ -15,6 +15,8 @@ CreateInputsCrit <- function(FUN_CRIT,
   
   ObjectClass <- NULL
   
+  FUN_CRIT <- match.fun(FUN_CRIT)
+  
   ## ---------- check arguments
   
   if (!missing(Qobs)) {

R/CreateInputsModel.R

@@ -9,6 +9,8 @@ CreateInputsModel <- function(FUN_MOD,
     
     ObjectClass <- NULL
     
+    FUN_MOD <- match.fun(FUN_MOD)
+    
     ##check_FUN_MOD
     BOOL <- FALSE
     if (identical(FUN_MOD, RunModel_GR4H)) {

R/CreateRunOptions.R

@@ -10,6 +10,8 @@ CreateRunOptions <- function(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndP
   
   ObjectClass <- NULL
   
+  FUN_MOD <- match.fun(FUN_MOD)
+  
   ##check_FUN_MOD
   BOOL <- FALSE;
   if (identical(FUN_MOD, RunModel_GR4H)) {

R/ErrorCrit.R

 ErrorCrit <- function(InputsCrit, OutputsModel, FUN_CRIT, warnings = TRUE, verbose = TRUE) {
   
+  FUN_CRIT <- match.fun(FUN_CRIT)
+  
   ## ---------- Arguments check
   
   if (!inherits(InputsCrit, "InputsCrit")) {

R/RunModel.R

 RunModel <- function(InputsModel, RunOptions, Param, FUN_MOD) {
+  FUN_MOD <- match.fun(FUN_MOD)
   return(FUN_MOD(InputsModel, RunOptions, Param))
 }

R/TransfoParam.R

 TransfoParam <- function(ParamIn, Direction, FUN_TRANSFO) {
+  FUN_TRANSFO <- match.fun(FUN_TRANSFO)
   return(FUN_TRANSFO(ParamIn, Direction))
 }