coco_pipe.report.from_experiment_result#

coco_pipe.report.from_experiment_result(result, *, feature_metadata=None, info=None, coords=None, sections='default', interactive=False, theme='paper', title='Decoding Report', config=None, asset_urls=None, qc_result=None, output_path=None, verbose=None, on_error='warn', section_options=None)#

Build a decoding report from an ~coco_pipe.decoding.result.ExperimentResult.

Parameters:

result (Any) – Decoding result object (e.g. ~coco_pipe.decoding.result.ExperimentResult).
feature_metadata (pd.DataFrame, optional) – Feature-level metadata for sensor map sections.
info (mne.Info, optional) – MNE Info for topomap rendering.
coords (array-like or DataFrame, optional) – Sensor coordinates used when MNE Info is unavailable.
sections (list of str or {"compact", "default", "full"}) – Ordered section keys or a named report preset.
interactive (bool) – If True, chart-like sections render interactive Plotly figures; topomap and sensor-map sections remain static Matplotlib images.
theme (str) – Matplotlib theme preset ("paper" | "notebook" | "poster").
title (str) – Report title.
config (dict, optional) – Extra configuration metadata stored in the report header.
asset_urls (dict, optional) – Override JavaScript asset URLs used by the report shell.
qc_result (QCResult, optional) – Structured QC drop log rendered as a standard report section.
output_path (path-like, optional) – If given, save the rendered report to this path.
verbose (bool, optional) – Override whether raw tables are rendered inline.
on_error ({"raise", "warn", "placeholder"}) – Policy for unexpected section-builder failures.
section_options (mapping, optional) – Per-section keyword overrides keyed by section name.

Returns:

Fully populated decoding report.

Return type:

Report