as
fun MixtureModelingResults.asMarkdown(heldOut: DoubleArray? = null, title: String = "Mixture Modeling Results", bootstrap: MixtureBootstrapResults? = null, includePlots: Boolean = false, description: MixtureDataDescription? = null, hasMechanism: Boolean = false, stability: PartitionStability? = null, adequacy: FitAdequacy? = null, variableName: String = "observed value"): String(source)
The standard report as Markdown, for pasting into a document that is already text.
Plots are omitted by default: Markdown has no way to carry an embedded interactive plot, so including them would produce captions with nothing under them.
Parameters
held
observations the fit has not seen, used for the coverage check
title
the document title
bootstrap
resampling results, when the caller has run them
include
whether to include the diagnostic panels
description
the pre-fit characterisation, when the caller has taken one
has
whether the analyst has a priori reason to believe in a mixing mechanism
stability
the cut-displacement measurement, when the caller has run it
adequacy
whether the fitted density reproduces its sample, when the caller has assessed it. Omitted from the document when absent.