eeg-report

Aggregate EEG stage outputs into mne.Report HTML and Markdown summaries.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/dengzhe-hou/auto-eeg-analysis --skill eeg-report
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: eeg-report
Source: https://github.com/dengzhe-hou/auto-eeg-analysis/tree/main/skills/eeg-report
Command: npx skills add https://github.com/dengzhe-hou/auto-eeg-analysis --skill eeg-report

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about eeg-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a COBIDAS-ready EEG report from MNE pipeline outputs?

To generate a COBIDAS-ready EEG report, aggregate post-processing outputs like FINDINGS.md and figure-stage files into a self-contained HTML using mne.Report, ensuring acquisition, preprocessing, and per-claim statistics are fully traceable.

What is COBIDAS-MEEG compliance and how is it enforced in EEG reporting?

COBIDAS-MEEG compliance requires reporting specific EEG methodology details to ensure reproducibility, enforced here by generating an explicit checklist that flags missing reporting items to reduce review friction.

How do I create a reproducibility receipt for EEG statistical analysis?

Create a reproducibility receipt by recording software versions, git state, RNG seeds, and SHA-256 hashes for key inputs and outputs, writing them into a REPRO_RECEIPT.md file for independent verification.

Can I draft a manuscript from mne.Report HTML outputs?

Yes, you can draft a manuscript using a matching Markdown summary builder that extracts core content, explicit per-claim verdicts, and figure links from the HTML report for manuscript workflows.

What inputs are required to build a complete EEG analysis report?

Building a complete EEG analysis report requires ANALYSIS_PLAN.md, DATASET_BRIEF.md, FINDINGS.md, ENVIRONMENT.json, and figure-stage outputs to populate the HTML and Markdown summaries without fabricating data.

Does the EEG report builder track pipeline stage artifacts?

Yes, the builder scans the project directory to inventory available stage outputs and writes a STAGE_INVENTORY.json file, ensuring every statistical claim and figure is traceable to its pipeline artifact.