load_mse_plot_data: Load an mse plot object RDS file which holds the output of...

View source: R/load_mse_plot_data.R

load_mse_plot_dataR Documentation

Load an mse plot object RDS file which holds the output of setup_mse_plot_objects()

Description

Load an mse plot object RDS file which holds the output of setup_mse_plot_objects()

Usage

load_mse_plot_data(
  scenario = NULL,
  overwrite_rds = FALSE,
  main_results_dir = "results",
  quants = c(0.05, 0.5, 0.95),
  ...
)

Arguments

scenario

The name of the scenario. This is the name of a subdirectory found in the main_results_dir directory of the project.

overwrite_rds

Logical. If TRUE and the file exists, it will be overwritten. If FALSE, the file will be created if it does not exist and left as-is if it exists.

main_results_dir

The name of the results directory which holds the mse output subdirectories in the project.

quants

Quantile values to use

...

Arguments to send to merge_run_data()

Details

If the file exists and overwrite_rds is FALSE, the file is read in and the content object is returned. If the file does not exist, it is created prior to the results being returned.

Value

The object which was returned by setup_mse_plot_objects()


pacific-hake/pacifichakemse documentation built on June 11, 2024, 4:07 a.m.