coco_pipe.report.api¶

High-level API for generating Reports from various sources.

Functions¶

`from_container`(→ coco_pipe.report.core.Report)	Create a standard report from a DataContainer.
`from_bids`(→ coco_pipe.report.core.Report)	Auto-generate a report from a BIDS dataset.
`from_tabular`(→ coco_pipe.report.core.Report)	Auto-generate a report from a tabular file (CSV/Excel).
`from_embeddings`(→ coco_pipe.report.core.Report)	Auto-generate a report from a directory of embeddings.
`from_reductions`(→ coco_pipe.report.core.Report)	Create a comparative report from multiple dimensionality reduction results.

Module Contents¶

coco_pipe.report.api.from_container(container: coco_pipe.io.structures.DataContainer, title: str = 'Analysis Report', config: Dict | None = None, raw_preview: bool = True) → coco_pipe.report.core.Report[source]¶

Create a standard report from a DataContainer.

Parameters:

container (DataContainer) – The data to summarize.
title (str) – Report title.
config (Dict, optional) – Configuration/provenance info.
raw_preview (bool) – If True, adds an interactive raw data scroller. Default True.

Returns:

A Report object with a “Data Overview” section added.

Return type:

Report

Examples

>>> ds = TabularDataset("data.csv")
>>> container = ds.load()
>>> report = from_container(container)
>>> report.save("report.html")

coco_pipe.report.api.from_bids(root: str | pathlib.Path, task: str | None = None, **kwargs) → coco_pipe.report.core.Report[source]¶

Auto-generate a report from a BIDS dataset.

Parameters:

root (str or Path) – BIDS root directory.
task (str, optional) – Task name.
**kwargs – Additional arguments passed to BIDSDataset (e.g., session, subjects).

Returns:

A Report object with a “Data Overview” section added.

Return type:

Report

Examples

>>> report = from_bids("/path/to/bids")
>>> report.save("report.html")

coco_pipe.report.api.from_tabular(path: str | pathlib.Path, **kwargs) → coco_pipe.report.core.Report[source]¶

Auto-generate a report from a tabular file (CSV/Excel).

Parameters:

path (str or Path) – Path to file.
**kwargs – Additional arguments passed to TabularDataset (e.g., target_col, clean).

Return type:

Report

coco_pipe.report.api.from_embeddings(path: str | pathlib.Path, **kwargs) → coco_pipe.report.core.Report[source]¶

Auto-generate a report from a directory of embeddings.

Parameters:

path (str or Path) – Directory containing embedding files.
**kwargs – Additional arguments passed to EmbeddingDataset.

Return type:

Report

Examples

>>> report = from_embeddings("/path/to/embeddings")
>>> report.save("report.html")

coco_pipe.report.api.from_reductions(reductions: List[Any], container: coco_pipe.io.structures.DataContainer | None = None, embeddings: List[numpy.ndarray] | None = None, labels: numpy.ndarray | None = None, metadata: Dict[str, Any] | None = None, times: numpy.ndarray | None = None, title: str = 'DimReduction Comparison', config: Dict | None = None) → coco_pipe.report.core.Report[source]¶

Create a comparative report from multiple dimensionality reduction results.

Parameters:

reductions (List[Any]) – List of scored reduction objects implementing get_summary().
container (DataContainer, optional) – Original data container to include in “Data Overview”.
embeddings (list of np.ndarray, optional) – Explicit embedding payloads aligned with reductions.
labels (np.ndarray, optional) – Optional labels aligned with each embedding.
metadata (dict, optional) – Optional column-oriented metadata aligned with 2D embeddings.
times (np.ndarray, optional) – Optional time axis aligned with 3D trajectory embeddings.
title (str) – Report title.

Returns:

Report with Data Overview (if valid) and one section per reduction.

Return type:

Report

Notes

Reduction summaries no longer carry cached embedding payloads. Pass embeddings explicitly when the report should render embedding or trajectory plots.

Examples

>>> report = from_reductions([pca, tsne], embeddings=[pca_emb, tsne_emb])
>>> report.save("report.html")