set_dirs: Set and return all model directories for the project
In pacific-hake/hake-assessment: Stock Assessment for Pacific Hake

set_dirs

R Documentation

Set and return all model directories for the project

Description

Set and return all model directories for the project

Usage

set_dirs(
  models_dir = NA,
  last_yr_models_dir = NA,
  base_models_dir = "01-base-models",
  bridge_models_dir = "02-bridging-models",
  sens_models_dir = "03-sensitivity-models",
  request_models_dir = "04-request-models",
  test_models_dir = "05-test-models",
  base_models_dirs = NA,
  bridge_models_dirs = NA,
  sens_models_dirs = NA,
  request_models_dirs = NA,
  test_models_dirs = NA,
  prepend_to_bridge = NA,
  suppress_warnings = FALSE
)

Arguments

`models_dir`	Full path in which the SS3 model directories are located for the current assessment year
`last_yr_models_dir`	Full path in which the SS3 model directories are located for the the last assessment year
`base_models_dir`	Name of the base models directory
`bridge_models_dir`	Name of the bridging models directory
`sens_models_dir`	Name of the sensitivity models directory
`request_models_dir`	Name of the request models directory
`test_models_dir`	Name of the test models directory
`base_models_dirs`	A vector of subdirectory names in `base_models_dir` that each contain an individual SS3 base model
`bridge_models_dirs`	A vector of subdirectory names in `bridge_models_dir` that each contain an individual SS3 bridge model
`sens_models_dirs`	A vector of subdirectory names in `sens_models_dir` that each contain an individual SS3 sensitivity model
`request_models_dirs`	A vector of subdirectory names in `request_models_dir` that each contain an individual SS3 base model request model
`test_models_dirs`	A vector of subdirectory names in `test_models_dir` that each contain an individual SS3 base model test model
`prepend_to_bridge`	A vector of logical values, the same length as the number of groups of bridge models (`length(bridge_models_dirs)`) which, if `TRUE` will prepend the ⁠last_yr_base_model_dir``to the beginning of the group of that element number. If ⁠NULL`or`NA', no prepending will take place
`suppress_warnings`	If `TRUE`, warnings about directories not existing will not be shown

Details

Sensitivity groups will have the base model directory prepended, The bridge model groups can have last_yr_base_model_dir prepended if prepend_to_bridge is set to TRUE for the model group. If directories do not exist, they will be assigned NULL and a warning issued. If the models_dir does not exist, an error will be thrown.