diff --git a/R/Calibration.R b/R/Calibration.R index 3cce7b368bb73854c59f6a6ab2cd91af40731302..d526294f62ef1d2f7a66a1e2180f72b9e506d75f 100644 --- a/R/Calibration.R +++ b/R/Calibration.R @@ -3,6 +3,7 @@ Calibration <- function(InputsModel, InputsCrit, CalibOptions, FUN_MOD, + FUN_CRIT, # deprecated FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL, verbose = TRUE, @@ -10,6 +11,10 @@ Calibration <- function(InputsModel, FUN_MOD <- match.fun(FUN_MOD) + if (!missing(FUN_CRIT)) { + FUN_CRIT <- match.fun(FUN_CRIT) + } + FUN_CALIB <- match.fun(FUN_CALIB) if (!is.null(FUN_TRANSFO)) { diff --git a/R/Calibration_Michel.R b/R/Calibration_Michel.R index 854ab723146e860f20b7e884b7523b68a570cd05..4a60a4ca1732b389d175da0315c6611fac48c86d 100644 --- a/R/Calibration_Michel.R +++ b/R/Calibration_Michel.R @@ -3,6 +3,7 @@ Calibration_Michel <- function(InputsModel, InputsCrit, CalibOptions, FUN_MOD, + FUN_CRIT, # deprecated FUN_TRANSFO = NULL, verbose = TRUE, ...) { @@ -10,6 +11,10 @@ Calibration_Michel <- function(InputsModel, FUN_MOD <- match.fun(FUN_MOD) + if (!missing(FUN_CRIT)) { + FUN_CRIT <- match.fun(FUN_CRIT) + } + # Handling 'FUN_TRANSFO' from direct argument or provided by 'CaliOptions' if (!is.null(FUN_TRANSFO)) { FUN_TRANSFO <- match.fun(FUN_TRANSFO) @@ -52,6 +57,10 @@ Calibration_Michel <- function(InputsModel, if (!inherits(CalibOptions, "HBAN")) { stop("'CalibOptions' must be of class 'HBAN' if 'Calibration_Michel' is used") } + if (!missing(FUN_CRIT)) { + warning("argument 'FUN_CRIT' is deprecated. The error criterion function is now automatically get from the 'InputsCrit' object") + } + ##_variables_initialisation ParamFinalR <- NULL diff --git a/man/Calibration.Rd b/man/Calibration.Rd index 65d8ee7a3fcd5f91e8d6a57408ae4c2ee285bb85..f6a7637edba9a4023d393f28be917b613e078a56 100644 --- a/man/Calibration.Rd +++ b/man/Calibration.Rd @@ -15,7 +15,7 @@ Calibration algorithm that optimises the error criterion selected as objective f \usage{ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, - FUN_MOD, FUN_CALIB = Calibration_Michel, + FUN_MOD, FUN_CRIT, FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL, verbose = TRUE, ...) } @@ -31,6 +31,8 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, \item{FUN_MOD}{[function] hydrological model function (e.g. \code{\link{RunModel_GR4J}}, \code{\link{RunModel_CemaNeigeGR4J}})} +\item{FUN_CRIT}{(deprecated) [function] error criterion function (e.g. \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}})} + \item{FUN_CALIB}{(deprecated) [function] calibration algorithm function (e.g. \code{\link{Calibration_Michel}}), \code{default = Calibration_Michel}} \item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the \code{FUN_MOD} used is native in the package \code{FUN_TRANSFO} is automatically defined} diff --git a/man/Calibration_Michel.Rd b/man/Calibration_Michel.Rd index 6befd8b0c9293d84e43fffe5490c594de3ddbd12..28de8c4424cc84889a83fdbd9a123d5329c7af3f 100644 --- a/man/Calibration_Michel.Rd +++ b/man/Calibration_Michel.Rd @@ -19,7 +19,7 @@ Then a steepest descent local search algorithm is performed, starting from the r \usage{ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, - FUN_MOD, FUN_TRANSFO = NULL, verbose = TRUE, ...) + FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE, ...) } @@ -34,6 +34,8 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, \item{FUN_MOD}{[function] hydrological model function (e.g. \code{\link{RunModel_GR4J}}, \code{\link{RunModel_CemaNeigeGR4J}})} +\item{FUN_CRIT}{(deprecated) [function] error criterion function (e.g. \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}})} + \item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the \code{FUN_MOD} used is native in the package \code{FUN_TRANSFO} is automatically defined} \item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}}