coco_pipe.report.from_container#

coco_pipe.report.from_container(container, title='Analysis Report', config=None, raw_preview=True, theme='paper', asset_urls=None, output_path=None)#

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.

  • theme (str) – Report theme preset.

  • asset_urls (dict, optional) – Override JavaScript asset URLs used by the report shell.

  • output_path (path-like, optional) – If given, save the rendered report to this path.

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")