KSLCore/ksl.app.results.comparison/ComparisonReportRenderer

ComparisonReportRenderer

Renderer for the comparison analyzer. Translates the current observation map (gathered from a ComparisonSelectionModel in practice) into a report document via the substrate's existing report-DSL extensions (multiBoxPlot, multipleComparison, ConfidenceIntervalsPlot) and writes it in every requested ReportFormat.

The renderer writes files only; it does not open them in any viewer. Hosts that want browser-open behavior consult WriteOutcome.htmlPath after the render call and dispatch through their own platform channel (e.g. java.awt.Desktop.browse in a Swing host).

Pure side-effect-bearing object: no UI state, no Swing dependencies. Callers driving it from a unit test can build the inputs by hand and inspect the returned WriteOutcome without standing up a frame.

Types

WriteOutcome

data class WriteOutcome(val written: List<Path>, val errors: List<String>)

Result of a render call. Lets the caller surface per-format successes and errors in one notification pass, and locate the HTML output (if any) for host-side browser-open.

Functions

renderBoxPlot

fun renderBoxPlot(sourceLabel: String, responseName: String, observations: Map<String, DoubleArray>, outputDir: Path, formats: Set<ReportFormat>, caption: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null): ComparisonReportRenderer.WriteOutcome

Render a cross-experiment box plot for responseName.

renderCiPlot

fun renderCiPlot(sourceLabel: String, responseName: String, observations: Map<String, DoubleArray>, outputDir: Path, formats: Set<ReportFormat>, level: Double = 0.95, referencePoint: Double? = null, caption: String? = null, title: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null): ComparisonReportRenderer.WriteOutcome

Render a side-by-side CI plot for responseName — one mean ± CI bar per checked experiment that records the response.

renderMca

fun renderMca(sourceLabel: String, responseName: String, observations: Map<String, DoubleArray>, outputDir: Path, formats: Set<ReportFormat>, direction: MCBDirection = MCBDirection.BOTH, indifferenceZone: Double = 0.0, altConfidenceLevel: Double = 0.95, diffConfidenceLevel: Double = 0.95, probCorrectSelection: Double = 0.95, showAltCIPlot: Boolean = false, showBoxPlot: Boolean = false, title: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null): ComparisonReportRenderer.WriteOutcome

Render a Multiple Comparison Analysis report for responseName against observations.