eeg-report

What problem does it solve?

Producing publication-quality EEG reporting requires stitching together many pipeline outputs, enforcing COBIDAS-MEEG completeness, and ensuring every claim is traceable to figures and stage artifacts.

Core Features & Use Cases

• Self-contained HTML report (mne.Report): Embeds acquisition, preprocessing, ICA, epoching, evoked/TFR results, and per-claim statistical summaries into a single interactive HTML artifact suitable for sharing and review.
• Markdown summary builder: Generates a structured REPORT.md containing the same core content with explicit per-claim verdicts and figure links for manuscript drafting workflows.
• Reproducibility receipt (REPRO_RECEIPT.md): Records versions, git state, RNG seeds, and SHA-256 hashes for key inputs/outputs so results can be independently verified.
• COBIDAS-MEEG compliance checklist: Produces an explicit checklist and flags missing reporting items to reduce Reviewer 2 back-and-forth.
• Stage inventory: Scans the project directory to inventory available stage outputs and writes report-stage/STAGE_INVENTORY.json for traceability.

Quick Start

Use the eeg-report skill on your project directory after eeg-stats and eeg-figure are complete to create report-stage/report.html and report-stage/REPORT.md together with report-stage/REPRO_RECEIPT.md.