Write a POPMAPS surface comparison report

write_surface_comparison_report() writes the main tables, diagnostic plots, and a small Markdown interpretation file from a compare_popmaps_surfaces() result. It is designed for reproducible local validation runs where users need durable artifacts to compare candidate geographic, suitability, conductance, or resistance surfaces.

Usage

write_surface_comparison_report(
  comparison,
  dir = ".",
  prefix = "surface-comparison",
  include_tuning_results = TRUE,
  overwrite = TRUE,
  width = 1500,
  height = 900,
  res = 150
)

Arguments

comparison

A popmaps_surface_comparison object returned by compare_popmaps_surfaces().

dir

Output directory. Created recursively if needed.

prefix

File prefix used for all report artifacts.

include_tuning_results

Logical. If TRUE, write one full tune_popmaps() results CSV per candidate surface.

overwrite

Logical. If FALSE, stop before replacing an existing output file.

width, height, res

PNG device settings for report figures.

Value

A popmaps_surface_comparison_report list containing paths to the written report, tables, figures, and optional tuning-result CSVs.