helper_RunModel.R

#' Prepare useful variables for GRiwrm tests
#'
#' @return [environment] with the variables (See examples section)
#' @noRd
#'
#' @examples
#' # data set up
#' e <- setupRunModel()
# variables are copied from environment 'e' to the current environment
# https://stackoverflow.com/questions/9965577/r-copy-move-one-environment-to-another
#' for(x in ls(e)) assign(x, get(x, e))
#'
setupRunModel <-
  function(runInputsModel = TRUE,
           runRunOptions = TRUE,
           runRunModel = TRUE,
           griwrm = NULL) {

    data(Severn)

    # Format observation
    BasinsObs <- Severn$BasinsObs
    DatesR <- BasinsObs[[1]]$DatesR
    PrecipTot <-
      cbind(sapply(BasinsObs, function(x) {
        x$precipitation
      }))
    PotEvapTot <- cbind(sapply(BasinsObs, function(x) {
      x$peti
    }))
    Qobs <- cbind(sapply(BasinsObs, function(x) {
      x$discharge_spec
    }))

    # Set network
    if(is.null(griwrm)) {
      nodes <-
        Severn$BasinsInfo[, c("gauge_id", "downstream_id", "distance_downstream", "area")]
      nodes$model <- "RunModel_GR4J"
      griwrm <-
        CreateGRiwrm(nodes,
                     list(
                       id = "gauge_id",
                       down = "downstream_id",
                       length = "distance_downstream"
                     ))
    }

    # Convert meteo data to SD (remove upstream areas)
    Precip <- ConvertMeteoSD(griwrm, PrecipTot)
    PotEvap <- ConvertMeteoSD(griwrm, PotEvapTot)

    # set up inputs
    if (!runInputsModel)
      return(environment())
    InputsModel <-
      suppressWarnings(CreateInputsModel(griwrm, DatesR, Precip, PotEvap, Qobs))

    # RunOptions
    if (!runRunOptions)
      return(environment())
    e <- setupRunOptions(InputsModel)
    for (x in ls(e)) assign(x, get(x, e))
    rm(e)

    # RunModel.GRiwrmInputsModel
    if (!runRunModel)
      return(environment())
    OM_GriwrmInputs <- RunModel(InputsModel,
                                RunOptions = RunOptions,