CreateRunOptions.R 2.53 KiB
#' Creation of the RunOptions object
#'
#' This function can be used either for a catchment (with an \emph{InputsModel} object) or for a network (with a \emph{GRiwrmInputsModel} object)
#'
#' @template param_x
#' @param InputsModel object of class \emph{InputsModel} (only used to be consistent
#'        with the original [airGR::CreateRunOptions] which has `FUN_MOD` as first
#'        parameter)
#'        see [airGR::CreateInputsModel] for details
#' @param ... arguments passed to [airGR::CreateRunOptions], see details
#' @details See [airGR::CreateRunOptions] documentation for a complete list of arguments.
#' If `x` argument is a \emph{GRiwrmInputsModel} object, `IniStates` must be a
#' list of [numeric] object of class \emph{IniStates} with one item per modeled sub-catchment.
#' With a \emph{GRiwrmInputsModel} object, all arguments are applied on each
#' sub-catchments of the network.
#' @return Depending on the class of `InputsModel` argument (respectively
#' \emph{InputsModel} and \emph{GRiwrmInputsModel} object), the returned value is respectively:
#' - a `RunOptions` object (See [airGR::CreateRunOptions])
#' - a `GRiwrmRunOptions` object which is a [list] of `RunOptions` objects with one item per modeled sub-catchment
#' @rdname CreateRunOptions
#' @export
#' @example man-examples/RunModel.GRiwrmInputsModel.R
CreateRunOptions <- function(x, ...) {
  UseMethod("CreateRunOptions", x)
#' @rdname CreateRunOptions
#' @export
CreateRunOptions.InputsModel <- function(x, ...) {
  hasFUN_MOD <- "FUN_MOD" %in% names(list(...))
  if (!hasFUN_MOD && !is.null(x$FUN_MOD)) {
    CreateRunOptions(x,
                     FUN_MOD = x$FUN_MOD,
                     ...)
  } else if (hasFUN_MOD){
    # Temporary fix waiting for resolution of HYCAR-Hydro/airgr#167
    if (identical(match.fun(x$FUN_MOD), RunModel_Lag)) {
      dots <- list(...)
      dots$InputsModel <- x
      dots$IniStates <- CreateIniStates(RunModel_Lag, x)
      do.call(airGR::CreateRunOptions, dots)
    } else {
      # End of temporary fix HYCAR-Hydro/airgr#167
      airGR::CreateRunOptions(InputsModel = x, ...)
  } else {
    stop(" The parameter `FUN_MOD` must be defined")
#' @rdname CreateRunOptions
#' @export
CreateRunOptions.character <- function(x, InputsModel, ...) {
  CreateRunOptions(x = InputsModel,
                   FUN_MOD = x,
                   ...)
#' @rdname CreateRunOptions
#' @export
CreateRunOptions.function <- function(x, InputsModel, ...) {
  CreateRunOptions(x = InputsModel,
                   FUN_MOD = x,
                   ...)
71