designedExperiment

fun ReportBuilder.designedExperiment(de: DesignedExperimentIfc, confidenceLevel: Double = 0.95, coded: Boolean = false, showDetails: Boolean = false, boxPlotResponses: List<String> = emptyList(), caption: String? = null)(source)

Appends a self-contained section reporting the full structure and results of de.

Produces (inside a section titled caption or "Designed Experiment"):

  1. Overview paragraph — experiment name, design type, factor count, design point count, response count, number of runs executed, and display scale

  2. Design Structure sub-section — full experimentalDesign output (overview, optional CCD configuration, factor summary, design point matrix)

  3. Model Responses sub-section — DataTable listing all response and counter names collected by the model

  4. Paragraph notice when no design points have been executed

  5. Execution Summary sub-section (when runs exist) — DataTable (Point | Experiment Name | Reps | control columns | Status) with one row per executed design point; control columns are derived from ksl.controls.experiments.SimulationRun.inputs and vary by experiment

  6. Response Statistics sub-section (when runs exist) — one sub-section per response name; each sub-section contains a StatTable where each row represents one design point and reports the across-replication statistics (count, mean, std dev, half-width, CI bounds, min, max) at confidenceLevel; observations are taken from ksl.controls.experiments.SimulationRun.results

  7. Design Point Details sub-section (when showDetails is true) — one simulationRun section per executed design point, showing the complete run report including inputs, run parameters, and response statistics

Parameters

de

the DesignedExperimentIfc to report

confidenceLevel

confidence level for response statistics; defaults to 0.95

coded

false (default) = original measurement scale for the design point matrix; true = coded (−1/+1) scale

showDetails

true includes per-design-point simulationRun sections; defaults to false because these can be verbose for large designs; useful for audit trails and small experiments

boxPlotResponses

list of response names for which a ksl.utilities.io.plotting.MultiBoxPlot (one box per design point) is appended inside each response's sub-section of "Response Statistics"; an empty list (default) suppresses all box plots; pass DesignedExperimentIfc.responseNames to plot every response

caption

optional section title; defaults to "Designed Experiment"