KSLCore/ksl.utilities.io.report.extensions/bootstrapEstimate

bootstrapEstimate

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

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.

Produces (inside a section titled caption or BootstrapEstimateIfc.name):

Overview paragraph — name, label (when set), n, B, default CI level
Bootstrap Statistics DataTable — original estimate θ, bootstrap mean Eθ*, bias estimate, standard error estimate, MSE estimate
Confidence Intervals DataTable — Method | Lower | Upper for Std Normal, Basic, and Percentile at confidenceLevel; BCa and Bootstrap-t rows are added when be is a Bootstrap instance
Bootstrap Replicates Distribution sub-section (only when showDensityPlot is true) — a histogram of the B bootstrap replicates showing the empirical sampling distribution

Parameters

the BootstrapEstimateIfc to report

caption

optional section title; defaults to BootstrapEstimateIfc.name

confidenceLevel

confidence level for all CI computations; must be in (0, 1)

showDensityPlot

when true, appends a histogram of the bootstrap replicates