R/reset_model_inputs.R

In fishsciences/YoloBypassSBM: Yolo Bypass Salmon Benefits Model

#' Reset model inputs
#'
#' Reset model input data and parameters by removing any items with the same names from the global environment.
#'
#'
#' @md
#'
#' @export
#'
#'

reset_model_inputs <- function(){
  model_objs <- c("annual_abundance",
                  "cohort_data_template",
                  "flood_duration",
                  "floodplain_temperature_difference",
                  "floodplain_temperature",
                  "freeport_flow",
                  "freeport_temperature",
                  "fremont_weir_proportion",
                  "growth_parameters",
                  "knights_landing_fl_params",
                  "knights_landing_timing",
                  "length_weight_parameters",
                  "ocean_survival_parameters",
                  "rearing_proportion_parameters",
                  "rearing_survival_parameters",
                  "rearing_time_parameters",
                  "simulation_parameters",
                  "telemetry_parameters",
                  "toe_drain_temperature")

  model_objs_rm <- model_objs[model_objs %in% ls(envir = .GlobalEnv)]

  if (length(model_objs_rm) > 0){
    cat("Removed the following YoloBypassSBM objects from the global environment: ", toString(model_objs_rm), "\n")
    rm(list = model_objs_rm, envir = .GlobalEnv)
  } else {
    cat("No YoloBypassSBM objects needed to be removed from the global environment.\n")
  }
}