Package-level declarations

Types

Link copied to clipboard

Controls which MCB direction sections are rendered by multipleComparison.

Functions

Link copied to clipboard
fun ReportBuilder.allGoodnessOfFit(results: PDFModelingResults, modeler: PDFModeler, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section containing a goodnessOfFit sub-section for every distribution in results, sorted by overall MODA value (best first).

Link copied to clipboard
fun ReportBuilder.batchStatistic(bs: BatchStatistic, caption: String? = null, confidenceLevel: Double = 0.95)
Link copied to clipboard
fun ReportBuilder.bootstrap(bs: Bootstrap, caption: String? = null, confidenceLevel: Double = 0.95, showDensityPlot: Boolean = false)

Appends a self-contained section that first reports the Bootstrap configuration and then delegates to bootstrapEstimate for the statistical results.

Link copied to clipboard
fun ReportBuilder.bootstrapEstimate(be: BootstrapEstimateIfc, caption: String? = null, confidenceLevel: Double = 0.95, showDensityPlot: Boolean = false)

Appends a self-contained section reporting the results of a single BootstrapEstimateIfc. No configuration metadata (estimator, stream, antithetic) is emitted here; use bootstrap for Bootstrap instances that require configuration.

Link copied to clipboard
fun ReportBuilder.bootstrapEstimates(estimates: List<BootstrapEstimateIfc>, caption: String? = null, confidenceLevel: Double = 0.95, showDetail: Boolean = false, showDensityPlot: Boolean = false)
Link copied to clipboard
fun Model.buildReport(title: String = simulationName, block: ReportBuilder.() -> Unit = {}): ReportNode.Document

Convenience extension on Model that builds a ReportNode.Document in a single call, automatically wiring the model's SimulationReporter and time-series responses into a complete results report.

Link copied to clipboard
fun ReportBuilder.controlsReport(export: ModelControlsExport, groupByElement: Boolean = false, includeAllowedValues: Boolean = true, jsonValueWidth: Int = 60, includeComment: Boolean = true)

Appends a full controls report section for export.

Link copied to clipboard
fun ReportBuilder.dataStatisticalSummary(data: PDFData, caption: String? = null, confidenceLevel: Double = 0.95, showOutlierValues: Boolean = false)

Appends a self-contained section summarising the characteristics of the raw data held by data, with no plots.

Link copied to clipboard
fun ReportBuilder.dataVisualization(data: PDFData, caption: String? = null)

Appends a self-contained section containing four exploratory plots for the data held by data.

Link copied to clipboard

Appends a "Experiment Configuration" data table derived from ExperimentTableData and a derived replication count.

Link copied to clipboard
fun ReportBuilder.dbHistogram(responseName: String, binRows: List<HistogramTableData>, caption: String? = null, showPlot: Boolean = true)

Appends a single histogram sub-section for one response from the database.

fun ReportBuilder.dbHistogram(db: KSLDatabase, expName: String, responseName: String, showPlot: Boolean = true)

Appends a single histogram section for one in-simulation ksl.modeling.variable.HistogramResponse, fetched from the database by name.

Link copied to clipboard
fun ReportBuilder.dbIntegerFrequency(freqName: String, cellRows: List<FrequencyTableData>, caption: String? = null, showPlot: Boolean = true)

Appends a single integer-frequency sub-section for one response from the database.

fun ReportBuilder.dbIntegerFrequency(db: KSLDatabase, expName: String, name: String, showPlot: Boolean = true)

Appends a single integer-frequency section for one in-simulation ksl.modeling.variable.IntegerFrequencyResponse, fetched from the database by name.

Link copied to clipboard
fun ReportBuilder.dbResponseHistogram(db: KSLDatabase, expName: String, responseName: String, confidenceLevel: Double = 0.95, showPlot: Boolean = true)

Appends a "Histogram — responseName" section containing an across-replication statistics table for responseName and (when showPlot is true) a HistogramPlot built from the per-replication observations.

Link copied to clipboard
fun ReportBuilder.dbResponseNormality(db: KSLDatabase, expName: String, responseName: String)

Appends a "Normality — responseName" section containing a normal Q-Q plot and a normal P-P plot of the per-replication values, referenced against a Normal distribution fitted by moment matching (sample mean and variance).

Link copied to clipboard

Appends an "Observations — responseName" section containing an ObservationsPlot of the per-replication values in replication order — useful for spotting run-to-run trends or outliers that a histogram hides.

Link copied to clipboard
fun ReportBuilder.dbSimulationFrequencies(db: KSLDatabase, expName: String, showPlot: Boolean = true)

Appends a "Frequencies" section for the named experiment.

Link copied to clipboard
fun ReportBuilder.dbSimulationHistograms(db: KSLDatabase, expName: String, showPlot: Boolean = true)

Appends a "Histograms" section for the named experiment.

Link copied to clipboard
fun ReportBuilder.dbSimulationResults(db: KSLDatabase, expName: String, confidenceLevel: Double = 0.95, showPlots: Boolean = true)

Appends a complete set of sections for the named experiment in the following order:

Link copied to clipboard
fun ReportBuilder.dbSimulationSummary(db: KSLDatabase, expName: String, confidenceLevel: Double = 0.95)

Appends a "Simulation Summary" section for the named experiment, containing:

Link copied to clipboard
fun ReportBuilder.dbTimeSeriesAcrossReplication(db: KSLDatabase, expName: String, responseName: String, confidenceLevel: Double = 0.95, showPlot: Boolean = true)

Appends a "Time Series Across Replications — responseName" section containing a per-period statistics table (Period, Start, End, Count, Mean, Std Dev, Half Width, CI Lower, CI Upper, Min, Max) and a plot of the mean trajectory.

Link copied to clipboard
fun ReportBuilder.dbTimeSeriesPerReplication(db: KSLDatabase, expName: String, responseName: String, repIds: Set<Int>? = null, showPlot: Boolean = true)

Appends a "Time Series by Replication — responseName" section overlaying one line per replication, with the period index on the x-axis and the response value on the y-axis.

Link copied to clipboard
fun ReportBuilder.dbTimeSeriesResponses(db: KSLDatabase, expName: String, confidenceLevel: Double = 0.95, showPlots: Boolean = true)

Appends one across-replication time-series sub-section per distinct time-series response recorded for expName. Emits nothing when the experiment has no stored time-series data.

Link copied to clipboard
fun ReportBuilder.dbWithinReplicationDiagnostics(db: KSLDatabase, expName: String, responseName: String, confidenceLevel: Double = 0.95, showPlots: Boolean = true)

Appends a "Within-Replication Diagnostics — responseName" section bundling, in order: an across-replication statistics table, a histogram, an observations plot, and normal Q-Q / P-P plots — the full diagnostic set for one response.

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

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

Link copied to clipboard
fun ReportBuilder.designedExperimentBoxPlot(de: DesignedExperimentIfc, responseName: String, caption: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null)

Appends a MultiBoxPlot comparing per-replication distributions across executed design points for a single responseName in de.

Link copied to clipboard
fun ReportBuilder.designedExperimentRegression(de: DesignedExperimentIfc, responseName: String, linearModel: LinearModel, confidenceLevel: Double = 0.95, coded: Boolean = true, showDiagnosticPlots: Boolean = true, caption: String? = null)

Appends a self-contained regression-analysis section for a single response from de.

Link copied to clipboard
fun ReportBuilder.discreteDataSummary(pmf: PMFData, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section summarising the characteristics of the integer data held by pmf, with no plots.

Link copied to clipboard
fun ReportBuilder.discreteGoodnessOfFit(fit: PMFFitData, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section reporting the goodness-of-fit results for a single DiscretePMFGoodnessOfFit.

fun ReportBuilder.discreteGoodnessOfFit(gof: DiscretePMFGoodnessOfFit, modeler: PMFModeler, caption: String? = null, confidenceLevel: Double = 0.95)

Backward-compatible overload that renders the discrete goodness-of-fit section for a live DiscretePMFGoodnessOfFit, using modeler for the PMF comparison plot's empirical data. Delegates to the PMFFitData renderer.

Link copied to clipboard

Appends a self-contained section containing three exploratory plots for the integer data held by pmf. No fitted distribution is assumed.

Link copied to clipboard
fun ReportBuilder.experimentalDesign(design: ExperimentalDesignIfc, coded: Boolean = false, caption: String? = null)

Appends a self-contained section describing the complete structure of design.

Link copied to clipboard

Appends a single section containing a DataTable of all 15 run-configuration fields from params.

Link copied to clipboard
fun ReportBuilder.factor(factor: Factor, caption: String? = null)

Appends a single section describing all properties of factor.

Link copied to clipboard
fun ReportBuilder.goodnessOfFit(fit: PDFFitData, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section reporting the goodness-of-fit results for a single fitted distribution (PDFFitData).

fun ReportBuilder.goodnessOfFit(result: ScoringResult, modeler: PDFModeler, caption: String? = null, confidenceLevel: Double = 0.95)

Backward-compatible overload that renders the goodness-of-fit section for a live ScoringResult, using modeler for the bootstrap parameter estimates. Delegates to the PDFFitData renderer.

Link copied to clipboard
fun ReportBuilder.histogram(h: Histogram, caption: String? = null, confidenceLevel: Double = 0.95, showPlot: Boolean = true)

Appends a self-contained section that reports the bin structure, over/underflow summary, bin frequency table, statistics on binned observations, and a histogram plot.

fun ReportBuilder.histogram(h: HistogramIfc, caption: String? = null, confidenceLevel: Double = 0.95, showPlot: Boolean = true)

Overload of histogram that accepts a HistogramIfc reference.

Link copied to clipboard
fun ReportBuilder.integerFrequency(freq: IntegerFrequency, caption: String? = null, confidenceLevel: Double = 0.95, showStatistics: Boolean = true)

Appends a self-contained section that reports the frequency distribution, summary statistics on the observed integer values, and a frequency bar plot.

Link copied to clipboard
fun ReportBuilder.jsonControlsTable(controls: List<JsonControlData>, caption: String? = "JSON Controls", jsonValueWidth: Int = 60, includeComment: Boolean = true)

Appends a table of JSON controls from controls.

Link copied to clipboard
fun ReportBuilder.linearModel(model: LinearModel, caption: String? = null)

Appends a single section describing the terms of model.

Link copied to clipboard

Appends a self-contained section for a MC1DIntegration experiment.

Link copied to clipboard
fun ReportBuilder.mcExperiment(exp: MCExperiment, caption: String? = null)

Appends a self-contained section reporting the configuration, convergence diagnostics, and statistical estimate for any MCExperiment.

Link copied to clipboard

Appends a single Experiment Configuration section containing a DataTable of all setup parameters for exp.

Link copied to clipboard

Appends a single Convergence Diagnostics section for exp.

Link copied to clipboard

Appends a self-contained section for a MCMultiVariateIntegration experiment.

Link copied to clipboard
fun ReportBuilder.moda(model: AdditiveMODAModel, caption: String? = null)

Appends a self-contained section reporting the results of a live AdditiveMODAModel. This is a thin backward-compatible entry point: it projects the model into a MODAReportData holder via modaReportData and delegates to the moda overload that renders from the holder. See that overload for the section structure produced.

fun ReportBuilder.moda(data: MODAReportData, caption: String? = null)

Appends a self-contained section reporting MODA results from a MODAReportData holder. The holder is produced from a live AdditiveMODAModel (via modaReportData) or from a reconstructed/serialized result, so the same standard report renders from either source.

Link copied to clipboard
fun ReportBuilder.modaAnalysis(moda: MODAAnalyzer, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section reporting a MODAAnalyzer result.

Link copied to clipboard
fun ReportBuilder.multiBootstrap(mb: MultiBootstrap, caption: String? = null, confidenceLevel: Double = 0.95, showDetail: Boolean = false, showDensityPlot: Boolean = false)

Appends a self-contained section reporting a MultiBootstrap container: first the container configuration (name, estimator, per-factor n and B), then a bootstrapEstimates section for all internal Bootstrap instances.

Link copied to clipboard
fun ReportBuilder.multiBoxPlot(dataMap: Map<String, DoubleArray>, caption: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null)

Appends a MultiBoxPlot built from pre-assembled observation data.

Link copied to clipboard
fun ReportBuilder.multipleComparison(mca: MultipleComparisonAnalyzer, direction: MCBDirection = MCBDirection.BOTH, indifferenceZone: Double = mca.defaultIndifferenceZone, altConfidenceLevel: Double = mca.defaultLevel, diffConfidenceLevel: Double = mca.defaultLevel, probCorrectSelection: Double = mca.defaultLevel, showAltCIPlot: Boolean = false, showBoxPlot: Boolean = false, xAxisLabel: String? = null, yAxisLabel: String? = null)

Appends a self-contained section for a MultipleComparisonAnalyzer.

Link copied to clipboard
fun ReportBuilder.multipleComparisonBoxPlot(mca: MultipleComparisonAnalyzer, caption: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null)

Appends a MultiBoxPlot comparing the per-replication distributions of all alternatives in mca.

Link copied to clipboard
fun ReportBuilder.multipleComparisonCIPlot(mca: MultipleComparisonAnalyzer, confidenceLevel: Double = mca.defaultLevel, referencePoint: Double? = null, caption: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null)

Appends a ConfidenceIntervalsPlot showing the across-replication confidence interval for each alternative's mean.

Link copied to clipboard
fun ReportBuilder.numericControlsTable(controls: List<ControlData>, caption: String? = "Numeric Controls", includeComment: Boolean = true)

Appends a table of numeric controls from controls.

Link copied to clipboard
fun ReportBuilder.observationTrace(trace: ResponseTrace, repNums: List<Int> = trace.replicationNumbers.take(1), startTime: Double = 0.0, endTime: Double = Double.MAX_VALUE)

Appends one section per replication in repNums for an observation-based (ksl.modeling.variable.Response) ResponseTrace.

Link copied to clipboard

Appends a self-contained section containing residual diagnostics and three standard regression diagnostic plots for rr.

Link copied to clipboard
fun ReportBuilder.regressionParameters(rr: RegressionResultsIfc, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section containing the regression coefficient table and a significance summary for rr. No plots are included.

Link copied to clipboard
fun ReportBuilder.regressionSummary(rr: RegressionResultsIfc, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section containing the ANOVA decomposition and global model fit measures for rr. No plots are included.

Link copied to clipboard
fun ReportBuilder.responseTrace(trace: ResponseTrace, repNums: List<Int> = trace.replicationNumbers.take(1), startTime: Double = 0.0, endTime: Double = Double.MAX_VALUE)

Appends trace sections for a ResponseTrace, auto-selecting the correct visualisation based on ResponseTrace.isTimeWeighted.

Link copied to clipboard
fun ReportBuilder.scenario(scenario: Scenario, confidenceLevel: Double = 0.95, showTimings: Boolean = false, caption: String? = null)

Appends a section reporting the configuration and results of scenario.

Link copied to clipboard
fun ReportBuilder.scenarioRunner(runner: ScenarioRunner, confidenceLevel: Double = 0.95, showTimings: Boolean = false, boxPlotResponses: List<String> = emptyList(), caption: String? = null)

Appends a self-contained section reporting the full contents of runner.

Link copied to clipboard
fun ReportBuilder.scenarioRunnerBoxPlot(runner: ScenarioRunner, responseName: String, caption: String? = null, xAxisLabel: String? = null, yAxisLabel: String? = null)

Appends a MultiBoxPlot comparing per-replication distributions of a single responseName across the executed scenarios in runner.

Link copied to clipboard

Appends a section containing one sub-section per integer-frequency response collected by the model, each rendered by integerFrequency.

Link copied to clipboard
fun ReportBuilder.simulationHistograms(reporter: SimulationReporter, confidenceLevel: Double = 0.95)

Appends a section containing one sub-section per histogram collected by the model, each rendered by histogram.

Link copied to clipboard
fun ReportBuilder.simulationResults(reporter: SimulationReporter, model: Model? = null, confidenceLevel: Double = 0.95)

Appends a complete simulation results report as a sequence of sections inside the current builder scope, in the following order:

Link copied to clipboard
fun ReportBuilder.simulationRun(run: SimulationRun, confidenceLevel: Double = 0.95, showTimings: Boolean = false, caption: String? = null)

Appends a self-contained section reporting the full contents of run.

Link copied to clipboard
fun ReportBuilder.simulationSummary(reporter: SimulationReporter, model: Model? = null, confidenceLevel: Double = 0.95)

Appends a section containing simulation metadata (model name, experiment name, replications, run length, warm-up length) and the across-replication statistics half-width summary table.

Link copied to clipboard
fun ReportBuilder.simulationTimeSeries(model: Model, confidenceLevel: Double = 0.95)

Appends a section containing one sub-section per TimeSeriesResponse found in the model, each rendered by timeSeriesResponse.

Link copied to clipboard

Appends a completed-snapshot across-replication statistics section.

Link copied to clipboard
fun ReportBuilder.snapshotHistogram(responseName: String, binRows: List<HistogramTableData>, caption: String? = null, showPlot: Boolean = true)

Appends a single histogram section from snapshot histogram rows.

Link copied to clipboard
fun ReportBuilder.snapshotIntegerFrequency(frequencyName: String, cellRows: List<FrequencyTableData>, caption: String? = null, showPlot: Boolean = true)

Appends a single integer-frequency section from snapshot frequency rows.

Link copied to clipboard

Appends a run-summary section for the simulation run embedded in an SimulationSnapshot.ExperimentCompleted snapshot.

Link copied to clipboard

Appends a "Frequencies" section for a completed snapshot.

Link copied to clipboard

Appends a "Histograms" section for a completed snapshot.

Link copied to clipboard
fun ReportBuilder.snapshotSimulationResults(snapshot: SimulationSnapshot.ExperimentCompleted, showPlots: Boolean = true, showTimeSeries: Boolean = true, showDiagnostics: Boolean = false, timeSeriesConfidenceLevel: Double = 0.95)

Appends the standard completed-snapshot report sections in canonical order.

Link copied to clipboard

Appends a "Time-Series Responses" section from completed-snapshot time-series rows.

Link copied to clipboard
fun ReportBuilder.solver(s: Solver, caption: String? = null)

Convenience overload that reads Solver.solverResult and delegates to solverResult.

Link copied to clipboard
fun ReportBuilder.solverConfiguration(s: Solver, caption: String = "Solver Configuration")

Appends a single DataTable enumerating the supplied solver's configuration properties — the structured form of Solver.toString, usable in any ReportBuilder-built document.

Link copied to clipboard
fun ReportBuilder.solverResult(result: SolverResult, caption: String? = null)

Appends a self-contained section reporting the outcome of a simulation optimisation run described by a SolverResult.

Link copied to clipboard
fun ReportBuilder.stateFrequency(freq: StateFrequency, caption: String? = null, confidenceLevel: Double = 0.95, showStatistics: Boolean = true, showTransitions: Boolean = true, showTransitionProportions: Boolean = false, showPlot: Boolean = true, proportions: Boolean = false)

Appends a self-contained section that reports the state frequency distribution, summary statistics on the observed state numbers, optional transition matrices, and a frequency bar plot.

Link copied to clipboard
fun ReportBuilder.stateVariableTrace(trace: ResponseTrace, repNums: List<Int> = trace.replicationNumbers.take(1), startTime: Double = 0.0, endTime: Double = Double.MAX_VALUE)

Appends one section per replication in repNums for a time-weighted (ksl.modeling.variable.TWResponse) ResponseTrace.

Link copied to clipboard
fun ReportBuilder.statistic(stat: StatisticIfc, confidenceLevel: Double = 0.95)

Appends a self-contained section for a single StatisticIfc instance.

Link copied to clipboard
fun ReportBuilder.statisticCompact(stat: StatisticIfc, caption: String? = null, confidenceLevel: Double = 0.95, detail: Boolean = false)

Appends a compact single-row ksl.utilities.io.report.ast.ReportNode.StatTable for stat without wrapping it in a section.

Link copied to clipboard
fun ReportBuilder.statistics(stats: List<StatisticIfc>, caption: String? = null, confidenceLevel: Double = 0.95, detail: Boolean = false)

Appends a single ksl.utilities.io.report.ast.ReportNode.StatTable for a list of StatisticIfc instances — the most common reporting case for across-replication summary statistics.

Link copied to clipboard
fun ReportBuilder.stringControlsTable(controls: List<StringControlData>, caption: String? = "String Controls", includeAllowedValues: Boolean = true, includeComment: Boolean = true)

Appends a table of string controls from controls.

Link copied to clipboard
fun ReportBuilder.stringFrequency(freq: StringFrequency, caption: String? = null, showPlot: Boolean = true, proportions: Boolean = false)

Appends a self-contained section that reports the frequency distribution and an optional frequency bar plot for a StringFrequency tabulation.

Link copied to clipboard
fun ReportBuilder.tabularFileSchema(file: TabularFile, caption: String? = null)

Appends a "Schema" section describing the column structure of any TabularFile.

Link copied to clipboard
fun ReportBuilder.tabularInputFileColumns(file: TabularInputFile, caption: String? = null, maxRows: Int = 500, confidenceLevel: Double = 0.95, showPlots: Boolean = true)

Appends a "Columns" section for a TabularInputFile with a dedicated sub-section for each column.

Link copied to clipboard
fun ReportBuilder.tabularInputFileResults(file: TabularInputFile, maxRows: Int = 500, confidenceLevel: Double = 0.95, detail: Boolean = false, showPlots: Boolean = true)

Appends the canonical full report for a TabularInputFile: a summary section followed by a per-column detail section.

Link copied to clipboard
fun ReportBuilder.tabularInputFileSummary(file: TabularInputFile, caption: String? = null, maxRows: Int = 500, confidenceLevel: Double = 0.95, detail: Boolean = false)

Appends a "Summary" section for a TabularInputFile containing the column schema, a compact across-column statistics table for all numeric columns, and a distinct/missing count table for all text columns.

Link copied to clipboard
fun ReportBuilder.timeSeriesResponse(ts: TimeSeriesResponse, confidenceLevel: Double = 0.95)

Appends a self-contained section that reports the configuration and per-period across-replication statistics for a TimeSeriesResponse.

Link copied to clipboard
fun KSLDatabase.toComparisonReport(responseName: String, expNames: List<String>, title: String = "Comparison — ", direction: MCBDirection = MCBDirection.BOTH, indifferenceZone: Double? = null, confidenceLevel: Double = 0.95, probCorrectSelection: Double = 0.95, showAltCIPlot: Boolean = true, showBoxPlot: Boolean = true): ReportNode.Document

Builds a ReportNode.Document containing a complete multiple-comparison analysis of one response across several experiments stored in this database.

Link copied to clipboard
fun KSLDatabase.toFrequencyReport(expName: String, name: String? = null, title: String = if (name == null) "Frequencies — $expName" else "Frequency — $name ($expName)", showPlot: Boolean = true): ReportNode.Document

Builds a ReportNode.Document for the stored integer-frequency data of one experiment.

Link copied to clipboard
fun KSLDatabase.toHistogramReport(expName: String, responseName: String? = null, title: String = if (responseName == null) "Histograms — $expName" else "Histogram — $responseName ($expName)", showPlot: Boolean = true): ReportNode.Document

Builds a ReportNode.Document for the stored histogram data of one experiment.

Link copied to clipboard
fun ExperimentRunParameters.toReport(title: String = "Experiment Run Parameters ", block: ReportBuilder.() -> Unit = { experimentRunParameters(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a standalone run-parameters report via experimentRunParameters.

fun Factor.toReport(title: String = name, block: ReportBuilder.() -> Unit = { factor(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a full factor report via factor.

fun LinearModel.toReport(title: String = "Linear Model", block: ReportBuilder.() -> Unit = { linearModel(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a full linear model report via linearModel.

fun TabularOutputFile.toReport(title: String = path.fileName.toString(), block: ReportBuilder.() -> Unit = { tabularFileSchema(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document for this TabularOutputFile whose default content is a schema section (tabularFileSchema).

fun MC1DIntegration.toReport(title: String = "MC 1D Integration", block: ReportBuilder.() -> Unit = { mc1DIntegration(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a full 1-D integration report via mc1DIntegration (problem setup + configuration + diagnostics + estimate).

fun MCExperiment.toReport(title: String = "Monte Carlo Experiment", block: ReportBuilder.() -> Unit = { mcExperiment(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a full Monte Carlo experiment report via mcExperiment. Suitable for any MCExperiment, including user-defined subclasses that supply a custom ksl.utilities.mcintegration.MCReplicationIfc.

fun MCMultiVariateIntegration.toReport(title: String = "MC Multivariate Integration", block: ReportBuilder.() -> Unit = { mcMultiVariateIntegration(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a full multivariate integration report via mcMultiVariateIntegration (problem setup + configuration + diagnostics + estimate).

fun AdditiveMODAModel.toReport(title: String = name.ifBlank { "MODA Results" }, block: ReportBuilder.() -> Unit = { moda(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full MODA results section for this model (metric definitions, scores/values, rankings).

fun WeightedStatistic.toReport(title: String = name, block: ReportBuilder.() -> Unit = { weightedStatistic(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document whose default content is a vertical property-sheet section for this weighted statistic.

fun ExperimentalDesignIfc.toReport(title: String = "Experimental Design", coded: Boolean = false, block: ReportBuilder.() -> Unit = { experimentalDesign(this@toReport, coded) }): ReportNode.Document

Builds a ReportNode.Document containing a full experimental-design report via experimentalDesign.

fun Model.toReport(title: String = simulationName, confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { simulationResults(simulationReporter, this@toReport, confidenceLevel) }): ReportNode.Document

Builds a complete ReportNode.Document for this model using the standard simulation results structure (experiment metadata, across-replication statistics, histograms, frequencies, and time-series responses).

fun SimulationReporter.toReport(title: String = "Simulation Report", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { simulationSummary(this@toReport, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the simulation summary section (across-replication statistics table) for this reporter — without model metadata, since SimulationReporter does not expose the model reference directly.

fun PDFModeler.toReport(title: String = "Distribution Fitting — Data Analysis", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { dataStatisticalSummary(this@toReport, confidenceLevel = confidenceLevel) dataVisualization(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a data exploration report for this PDFModeler — statistical summary and visualization plots — with no fitting results. Suitable for EDA before committing to a fitting run.

fun PMFModeler.toReport(title: String = "Discrete Distribution Fitting — Data Analysis", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { discreteDataSummary(this@toReport, confidenceLevel = confidenceLevel) discreteVisualization(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a discrete data exploration report — statistical summary and visualization plots — with no goodness-of-fit analysis. Suitable for EDA before committing to a specific distribution.

fun StatisticReporter.toReport(title: String = reportTitle ?: "Statistical Report", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { statistics(this@toReport.statistics, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is a compact half-width summary ksl.utilities.io.report.ast.ReportNode.StatTable for all statistics held by this reporter.

fun KSLDatabase.toReport(title: String = label, confidenceLevel: Double = 0.95, showPlots: Boolean = true): ReportNode.Document

Builds a ReportNode.Document covering all experiments stored in this database.

fun MODAAnalyzer.toReport(title: String = "MODA Analysis", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { modaAnalysis(this@toReport, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full MODA analysis (average performance, average model results, MCB comparisons, rank frequencies).

fun BatchStatistic.toReport(title: String = name, confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { batchStatistic(this@toReport, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full batch-statistic section (batch configuration table and statistics on batch means).

fun Histogram.toReport(title: String = name, confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { histogram(this@toReport, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full histogram section (overview paragraph, bin frequency table, statistics on binned data, and plot).

fun HistogramIfc.toReport(title: String = name, confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { histogram(this@toReport, confidenceLevel = confidenceLevel) }): ReportNode.Document
fun IntegerFrequency.toReport(title: String = name, confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { integerFrequency(this@toReport, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full integer-frequency section (overview paragraph, frequency table, statistics on observed values, and plot).

fun RegressionResultsIfc.toReport(title: String = "Regression Analysis — ", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { regressionSummary(this@toReport, confidenceLevel = confidenceLevel) regressionParameters(this@toReport, confidenceLevel = confidenceLevel) regressionDiagnostics(this@toReport) }): ReportNode.Document

Builds a ReportNode.Document containing a full OLS regression report: ANOVA + fit measures, parameter estimates with CIs, and diagnostic plots.

fun StatisticIfc.toReport(title: String = name, confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { statistic(this@toReport, confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is a full property-sheet section for this statistic (identical to calling statistic inside a report {} block).

fun WelchANOVA.toReport(title: String = "Welch's ANOVA", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { welchAnova(this@toReport, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full Welch's ANOVA section.

fun Scenario.toReport(title: String = "Scenario ", confidenceLevel: Double = 0.95, showTimings: Boolean = false, block: ReportBuilder.() -> Unit = { scenario(this@toReport, confidenceLevel, showTimings) }): ReportNode.Document

Builds a ReportNode.Document containing a standalone scenario report via scenario.

fun SimulationRun.toReport(title: String = "Simulation Run ", confidenceLevel: Double = 0.95, showTimings: Boolean = false, block: ReportBuilder.() -> Unit = { simulationRun(this@toReport, confidenceLevel, showTimings) }): ReportNode.Document

Builds a ReportNode.Document containing a full simulation run report via simulationRun.

fun DiscretePMFGoodnessOfFit.toReport(modeler: PMFModeler, title: String = "Discrete Distribution Fitting Analysis", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { discreteDataSummary(modeler, confidenceLevel = confidenceLevel) discreteVisualization(modeler) discreteGoodnessOfFit(this@toReport, modeler, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document containing a full discrete distribution fitting report: data statistical summary, visualization plots, and chi-squared goodness-of-fit analysis with a PMF comparison plot.

fun Bootstrap.toReport(title: String = "Bootstrap Analysis ", confidenceLevel: Double = 0.95, showDensityPlot: Boolean = false, block: ReportBuilder.() -> Unit = { bootstrap(this@toReport, confidenceLevel = confidenceLevel, showDensityPlot = showDensityPlot) }): ReportNode.Document

Builds a ReportNode.Document containing a full bootstrap report (configuration

fun BootstrapEstimateIfc.toReport(title: String = "Bootstrap Analysis ", confidenceLevel: Double = 0.95, showDensityPlot: Boolean = false, block: ReportBuilder.() -> Unit = { bootstrapEstimate(this@toReport, confidenceLevel = confidenceLevel, showDensityPlot = showDensityPlot) }): ReportNode.Document

Builds a ReportNode.Document containing a single-estimate bootstrap report via bootstrapEstimate. Does not include configuration metadata; use Bootstrap.toReport for Bootstrap instances.

fun MultipleComparisonAnalyzer.toReport(title: String = name.ifBlank { "Multiple Comparison Analysis" }, showAltCIPlot: Boolean = false, showBoxPlot: Boolean = false, block: ReportBuilder.() -> Unit = { multipleComparison(this@toReport, showAltCIPlot = showAltCIPlot, showBoxPlot = showBoxPlot) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full multiple-comparison analysis section using all defaults from the MultipleComparisonAnalyzer object itself (MultipleComparisonAnalyzer.defaultLevel, MultipleComparisonAnalyzer.defaultIndifferenceZone).

fun StringFrequency.toReport(title: String = name, showPlot: Boolean = true, proportions: Boolean = false, block: ReportBuilder.() -> Unit = { stringFrequency(this@toReport, showPlot = showPlot, proportions = proportions) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full string-frequency section (overview paragraph, frequency table, and plot).

fun List<BootstrapEstimateIfc>.toReport(title: String = "Bootstrap Estimates", confidenceLevel: Double = 0.95, showDetail: Boolean = false, showDensityPlot: Boolean = false, block: ReportBuilder.() -> Unit = { bootstrapEstimates(this@toReport, confidenceLevel = confidenceLevel, showDetail = showDetail, showDensityPlot = showDensityPlot) }): ReportNode.Document
fun ScenarioRunner.toReport(title: String = "Scenario Runner ", confidenceLevel: Double = 0.95, showTimings: Boolean = false, boxPlotResponses: List<String> = emptyList(), block: ReportBuilder.() -> Unit = { scenarioRunner(this@toReport, confidenceLevel, showTimings, boxPlotResponses) }): ReportNode.Document

Builds a ReportNode.Document containing a full scenario runner report via scenarioRunner.

fun ResponseTrace.toReport(title: String = name, repNums: List<Int> = replicationNumbers.take(1), startTime: Double = 0.0, endTime: Double = Double.MAX_VALUE, block: ReportBuilder.() -> Unit = { responseTrace(this@toReport, repNums, startTime, endTime) }): ReportNode.Document
fun PDFModelingResults.toReport(modeler: PDFModeler, title: String = "Distribution Fitting Analysis", confidenceLevel: Double = 0.95, allGOF: Boolean = false, block: ReportBuilder.() -> Unit = { dataStatisticalSummary(modeler, confidenceLevel = confidenceLevel) dataVisualization(modeler) moda(this@toReport.evaluationModel, caption = "MODA Scoring Results") if (allGOF) { allGoodnessOfFit(this@toReport, modeler, confidenceLevel = confidenceLevel) } else { goodnessOfFit(this@toReport.topResultByScore, modeler, confidenceLevel = confidenceLevel) } }): ReportNode.Document

Builds a ReportNode.Document containing a full distribution-fitting report: data statistical summary, visualization plots, MODA scoring results, and goodness-of-fit analysis.

fun KSLDatabase.toReport(expName: String, title: String = expName, confidenceLevel: Double = 0.95, showPlots: Boolean = true, block: ReportBuilder.() -> Unit = { dbSimulationResults(this@toReport, expName, confidenceLevel, showPlots) }): ReportNode.Document

Builds a ReportNode.Document for a single named experiment in this database.

fun MultiBootstrap.toReport(title: String = "Multi-Bootstrap Analysis ", confidenceLevel: Double = 0.95, showDetail: Boolean = false, showDensityPlot: Boolean = false, block: ReportBuilder.() -> Unit = { multiBootstrap(this@toReport, confidenceLevel = confidenceLevel, showDetail = showDetail, showDensityPlot = showDensityPlot) }): ReportNode.Document

Builds a ReportNode.Document containing a full multi-bootstrap report via multiBootstrap.

fun Controls.toReport(title: String? = null, groupByElement: Boolean = false, includeAllowedValues: Boolean = true, jsonValueWidth: Int = 60, includeComment: Boolean = true, block: ReportBuilder.() -> Unit = run { val export = this.exportAll() val lambda: ReportBuilder.() -> Unit = { controlsReport( export = export, groupByElement = groupByElement, includeAllowedValues = includeAllowedValues, jsonValueWidth = jsonValueWidth, includeComment = includeComment, ) } lambda }): ReportNode.Document

Builds a ReportNode.Document for this Controls instance.

fun ModelControlsExport.toReport(title: String? = null, groupByElement: Boolean = false, includeAllowedValues: Boolean = true, jsonValueWidth: Int = 60, includeComment: Boolean = true, block: ReportBuilder.() -> Unit = { controlsReport( export = this@toReport, groupByElement = groupByElement, includeAllowedValues = includeAllowedValues, jsonValueWidth = jsonValueWidth, includeComment = includeComment, ) }): ReportNode.Document
fun DesignedExperiment.toReport(title: String = "Designed Experiment ", confidenceLevel: Double = 0.95, coded: Boolean = false, showDetails: Boolean = false, boxPlotResponses: List<String> = emptyList(), block: ReportBuilder.() -> Unit = { designedExperiment(this@toReport, confidenceLevel, coded, showDetails, boxPlotResponses) }): ReportNode.Document

Builds a ReportNode.Document containing a full designed experiment report via designedExperiment.

fun DesignedExperimentIfc.toReport(title: String = "Designed Experiment ", confidenceLevel: Double = 0.95, coded: Boolean = false, showDetails: Boolean = false, boxPlotResponses: List<String> = emptyList(), block: ReportBuilder.() -> Unit = { designedExperiment(this@toReport, confidenceLevel, coded, showDetails, boxPlotResponses) }): ReportNode.Document

Builds a ReportNode.Document containing a full designed experiment report for any implementation of DesignedExperimentIfc.

fun WelchFileObserver.toReport(title: String = responseName, includePartialSums: Boolean = true, includeBatchMeans: Boolean = false, includeBiasTest: Boolean = false, deletionPoint: Int = -1, block: ReportBuilder.() -> Unit = { welchAnalysis( observer = this@toReport, includePartialSums = includePartialSums, includeBatchMeans = includeBatchMeans, includeBiasTest = includeBiasTest, deletionPoint = deletionPoint ) }): ReportNode.Document
fun TabularInputFile.toReport(title: String = path.fileName.toString(), maxRows: Int = 500, confidenceLevel: Double = 0.95, detail: Boolean = false, showPlots: Boolean = true, block: ReportBuilder.() -> Unit = { tabularInputFileResults( file = this@toReport, maxRows = maxRows, confidenceLevel = confidenceLevel, detail = detail, showPlots = showPlots ) }): ReportNode.Document

Builds a ReportNode.Document for this TabularInputFile whose default content is the full standard report (tabularInputFileResults): column schema, compact statistics table for numeric columns, text-column summary, and per-column drill-down sections with histograms and value-frequency tables.

fun SimulationSnapshot.ExperimentCompleted.toReport(title: String = defaultSnapshotTitle(this), showPlots: Boolean = true, showTimeSeries: Boolean = true, showDiagnostics: Boolean = false, timeSeriesConfidenceLevel: Double = 0.95, outputDirectory: OutputDirectory? = null, block: ReportBuilder.() -> Unit = { snapshotSimulationResults( this@toReport, showPlots = showPlots, showTimeSeries = showTimeSeries, showDiagnostics = showDiagnostics, timeSeriesConfidenceLevel = timeSeriesConfidenceLevel ) }): ReportNode.Document

Builds a report document for a completed simulation snapshot.

fun StateFrequency.toReport(title: String = name, confidenceLevel: Double = 0.95, showStatistics: Boolean = true, showTransitions: Boolean = true, showTransitionProportions: Boolean = false, showPlot: Boolean = true, proportions: Boolean = false, block: ReportBuilder.() -> Unit = { stateFrequency( this@toReport, confidenceLevel = confidenceLevel, showStatistics = showStatistics, showTransitions = showTransitions, showTransitionProportions = showTransitionProportions, showPlot = showPlot, proportions = proportions ) }): ReportNode.Document

Builds a ReportNode.Document whose default content is the full state-frequency section (overview paragraph, state frequency table, statistics on observed states, transition count matrix, and plot).

Link copied to clipboard
fun KSLDatabase.toTimeSeriesReport(expName: String, responseName: String? = null, title: String = if (responseName == null) "Time Series — $expName" else "Time Series — $responseName ($expName)", confidenceLevel: Double = 0.95, showPlots: Boolean = true): ReportNode.Document

Builds a ReportNode.Document of the stored time-series data for one experiment.

Link copied to clipboard
fun KSLDatabase.toWithinReplicationReport(expName: String, responseName: String, title: String = "Within-Replication — ", confidenceLevel: Double = 0.95, showPlots: Boolean = true): ReportNode.Document

Builds a ReportNode.Document containing the full within-replication diagnostic set for one response in one experiment stored in this database.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun ReportBuilder.welchAnalysis(analyzer: WelchDataFileAnalyzer, includePartialSums: Boolean = true, includeBatchMeans: Boolean = false, includeBiasTest: Boolean = false, deletionPoint: Int = -1)

Appends a warm-up analysis section for a WelchDataFileAnalyzer.

fun ReportBuilder.welchAnalysis(observer: WelchFileObserver, includePartialSums: Boolean = true, includeBatchMeans: Boolean = false, includeBiasTest: Boolean = false, deletionPoint: Int = -1)

Appends a warm-up analysis section for a WelchFileObserver.

Link copied to clipboard
fun ReportBuilder.welchAnova(anova: WelchANOVA, caption: String? = null, confidenceLevel: Double = 0.95)

Appends a self-contained section reporting the results of a WelchANOVA test.