renderBatchSummary

fun renderBatchSummary(result: RunResult.BatchCompleted, outputDir: Path, formats: Set<ReportFormat>, itemNames: Set<String>? = null, existingFilePolicy: BatchReportsWriter.FileHandlingPolicy = FileHandlingPolicy.OVERWRITE, batchFileStem: String = "scenario-summaries", reportTitle: String = "Batch Summary — ", itemTypeNamePlural: String = "scenarios", itemColumnHeader: String = "Scenario"): BatchReportsWriter.WriteOutcome(source)

Primary on-demand report. One document covering every completed item (or a caller-supplied subset). Sections:

  1. Run Overview — table with item name, requested reps, completed reps, run-error flag.

  2. Per-item across-replication statistics — one sub-section per item containing the response × stat table (Count, Mean, Std Dev, Half-width, CI bounds, Min, Max).

Designed to answer "how did my items stack up?" in one file, without forcing the analyst to flip between per-item reports.

Parameters

itemNames

optional whitelist of experiment.exp_name values to include. null (the default) includes every snapshot in result; a non-null set filters both the Run Overview rows and the per-item stat sub-sections. Empty set means "no items" and surfaces as an error in the returned WriteOutcome. Unknown names in the set are silently ignored.

batchFileStem

filename stem (no extension) for the consolidated document. Defaults to "scenario-summaries" to preserve Scenario-app filenames; Experiment-app hosts should pass a domain-natural value such as "batch-summary".

reportTitle

title that goes on the rendered document.

itemTypeNamePlural

the human-readable plural form used in body text (e.g. "scenarios", "design points").

itemColumnHeader

the Run Overview's leftmost column header (e.g. "Scenario", "Design Point").