Create configuration for the evaluation workflow

This function builds a configuration list containing all parameters required to run simulations and evaluation workflows.

make_config(
  stics_exe = NULL,
  workspace = NULL,
  metadata_file = NULL,
  run_simulations = TRUE,
  verbose = 1,
  parallel = FALSE,
  cores = NA,
  reference_workspace = NULL,
  percentage = 5,
  eval_workspace = DEFAULT_WORKSPACE,
  init_workspace = TRUE,
  output_dir = NULL,
  species = NULL,
  usms = NULL,
  var2exclude = NULL,
  force = FALSE
)

Arguments

stics_exe

Character. Path to the STICS executable.

workspace

Character. Path to the working directory containing simulation inputs.

metadata_file

Character. Path to the metadata file describing simulations.

run_simulations

Logical. Whether to run simulations. Defaults to TRUE.

verbose

Integer. Verbosity level for logging. Defaults to 1.

parallel

Logical. Whether to enable parallel execution. Defaults to FALSE.

cores

Integer or NA. Number of cores to use for parallel execution. If NA, the number of available cores may be used.

reference_workspace

Character or NULL. Path to reference evaluation data. If NULL, reference-based analyses may be skipped.

percentage

Numeric. Threshold used for evaluation metrics (e.g., detecting deteriorated variables). Defaults to 5.

eval_workspace

Character. Path to the evaluation workspace. Defaults to DEFAULT_WORKSPACE.

init_workspace

Logical. Whether to initialize the evaluation workspace. Defaults to TRUE.

output_dir

Character or NULL. Path to the output directory for exported files. Defaults to NULL.

species

Character vector or NULL. Optional list of species to evaluate. If NULL, all available species are evaluated. Defaults to NULL.

usms

Character vector or NULL. Optional list of USMs to evaluate. If NULL, all available USMs are evaluated. Defaults to NULL.

var2exclude

Character vector or NULL. Optional list of variables to exclude from evaluation. If NULL, all available variables are evaluated. Defaults to NULL.

force

Logical. Whether to overwrite an existing non-empty evaluation workspace without prompting. Defaults to FALSE.

Value

A named list containing the configuration parameters.

Details

The resulting configuration object can be passed to downstream functions to ensure consistent parameter handling.

Examples

if (FALSE) { # \dontrun{
config <- make_config(
  stics_exe = "/path/to/stics",
  workspace = "workspace/",
  metadata_file = "metadata.csv"
)
} # }