Run the full spatial sampling simulation (legacy wrapper)

run_spatial_simulation() is the historical end-to-end runner for spesim.

As of spesim 0.4.0, the recommended entry point is spesim_run(), which consolidates file-driven and programmatic workflows and returns a stable S3 object (spesim_result).

This function is retained for backwards compatibility and delegates to spesim_run(). It will emit a deprecation warning.

Usage

run_spatial_simulation(
  init_file = NULL,
  interactions_file = NULL,
  output_prefix = NULL,
  domain = NULL,
  P = NULL,
  write_outputs = TRUE,
  interactions_validate = TRUE,
  interactions_strict = TRUE,
  interactions_print = TRUE,
  interactions_top_n = 20
)

Arguments

init_file

Character path to a text configuration (KEY = value). If supplied, the config is read via load_config().

interactions_file

Optional character path for a separate interactions config. If NULL, interactions are resolved from P.

output_prefix

Base path for outputs (timestamp appended). If NULL, derives from P$OUTPUT_PREFIX.

domain

Optional sf polygon (study area). If NULL, a domain is created.

P

Optional parameter list. Used when init_file is not supplied.

write_outputs

Logical; write CSVs/figures/report to disk? Default TRUE.

interactions_validate, interactions_strict, interactions_print, interactions_top_n

Passed to spesim_run().

Value

A spesim_result.

Note

Deprecated since spesim 0.4.0. Use spesim_run() instead. Calling this function triggers .Deprecated("spesim_run"), which emits a warning and prints a message pointing to the replacement.

See also

spesim_run()