KSLCore/ksl.app.dist.reporting/toDocument

toDocument

fun BatchFitResultData.toDocument(title: String? = null, includePerDataset: Boolean = false): ReportNode.Document(source)

Builds the batch report document: the cross-dataset summary, and — when includePerDataset is true — a section per successful dataset reusing the single-result DTO-driven sections (data summary, ranked fits, MODA, and the recommended fit's goodness of fit). Per-dataset plots are not rendered here (the batch result carries no raw data); a caller holding a dataset's data can build that dataset's full document via FitResultData.toDocument.

fun FamilyFrequencyResult.toDocument(title: String? = null): ReportNode.Document(source)

Builds a standalone document for a FamilyFrequencyResult (the Bootstrap-tab analysis).

fun FitResultData.toDocument(rawData: DoubleArray? = null, title: String? = null, catalog: FittingCatalog = FittingCatalog, allGoodnessOfFit: Boolean = false): ReportNode.Document(source)

Builds the full report document from this result. Tables are always included; the goodness-of-fit detail and bootstrap summaries are added for the recommended fit (or every successful fit when allGoodnessOfFit is true); the four fit plots are added only when rawData is supplied.

Parameters

rawData

the client's original observations; required to render plots

title

document title; defaults to the dataset name

catalog

used to map a fit's family back to a distribution for plotting

allGoodnessOfFit

when true, GoF/plots cover every successful fit