#************************************************************************************************* #' Calibration algorithm which minimises the error criterion using the provided functions. \cr #************************************************************************************************* #' @title Calibration algorithm which minimises an error criterion on the model outputs using the provided functions #' @author 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{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}. #' @example tests/example_Calibration.R #' @export #' @encoding UTF-8 #_FunctionInputs__________________________________________________________________________________ #' @param InputsModel [object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details #' @param RunOptions [object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details #' @param InputsCrit [object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details #' @param CalibOptions [object of class \emph{CalibOptions}] see \code{\link{CreateCalibOptions}} for details #' @param FUN_MOD [function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J) #' @param FUN_CRIT [function] error criterion function (e.g. ErrorCrit_RMSE, ErrorCrit_NSE) #' @param FUN_CALIB (optional) [function] calibration algorithm function (e.g. Calibration_HBAN, Calibration_optim), default=Calibration_HBAN #' @param FUN_TRANSFO (optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined #' @param quiet (optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE #_FunctionOutputs_________________________________________________________________________________ #' @return [list] see \code{\link{Calibration_HBAN}} or \code{\link{Calibration_optim}} #************************************************************************************************** Calibration <- function(InputsModel,RunOptions,InputsCrit,CalibOptions,FUN_MOD,FUN_CRIT,FUN_CALIB=Calibration_HBAN,FUN_TRANSFO=NULL,quiet=FALSE){ return( FUN_CALIB(InputsModel,RunOptions,InputsCrit,CalibOptions,FUN_MOD,FUN_CRIT,FUN_TRANSFO,quiet=quiet) ) }