reports.generate_processing_report#

autoclean.functions.visualization.reports.generate_processing_report(raw_original, raw_cleaned, processing_steps, output_path, include_plots=True, title='EEG Processing Report', verbose=None)[source]#

Generate a comprehensive HTML processing report.

This function creates a detailed HTML report summarizing the EEG processing pipeline, including statistics, processing steps, and optional visualizations.

Parameters:

raw_originalmne.io.Raw: Original raw EEG data before processing.
raw_cleanedmne.io.Raw: Cleaned raw EEG data after processing.
processing_stepslist of dict: List of processing steps with metadata. Each dict should contain: - ‘step_name’: Name of the processing step - ‘parameters’: Dict of parameters used - ‘execution_time’: Time taken for the step - ‘description’: Brief description of what the step does
output_pathstr or Path: Path where the HTML report will be saved.
include_plotsbool, default True: Whether to include plots in the report.
titlestr, default “EEG Processing Report”: Title for the report.
verbosebool or None, default None: Control verbosity of output.

Returns:

report_pathstr: Path to the generated HTML report.

See also

plot_raw_comparison: Create before/after comparison plots
plot_ica_components: Visualize ICA components
create_processing_summary: Create JSON processing summary

Examples

>>> steps = [{'step_name': 'Filtering', 'parameters': {'low_freq': 0.1},
...           'execution_time': 2.3, 'description': 'Applied filter'}]
>>> report_path = generate_processing_report(raw_original, raw_cleaned, steps, "report.html")