Skip to main content

Tool for automated MEG data quality control

Project description

MEGqc

MEGqc is an open-source, BIDS-aligned toolbox for automated MEG quality assessment (QA) and explicit quality control (QC) summarization.

It is designed for large cohorts and reproducible workflows, and provides both:

  • interactive HTML reports for human inspection, and
  • machine-readable derivatives for downstream automation.

What MEGqc Provides

  • QA-first quality profiling of raw MEG signal quality before exclusion decisions.
  • Multi-metric coverage including:
    • standard deviation (STD),
    • peak-to-peak amplitude (PtP),
    • power spectral density (PSD),
    • ECG/EOG-related contamination,
    • high-frequency muscle burden,
    • optional head-motion summaries.
  • Multi-scale reporting across recording, channel, epoch, subject, dataset group, and multi-sample comparisons.
  • QC support layer with configurable module-level criteria and a Global Quality Index (GQI).
  • Reproducible execution with profile-aware outputs and saved settings provenance.
  • Three usage modes: CLI, GUI, and programmatic dispatchers.

Requirements

  • Python 3.10
  • MEG data organized according to BIDS/MEG-BIDS.

Installation

Use the official installation guide:

https://ancplaboldenburg.github.io/megqc_documentation/book/installation2.html

Quick Start (CLI)

  1. Export default config:
get-megqc-config --target_directory ./config
  1. Run QA/QC calculation:
run-megqc   --inputdata /path/to/bids_dataset   --config ./config/settings.ini
  1. Build plotting reports:
run-megqc-plotting --inputdata /path/to/bids_dataset
  1. Recompute GQI summaries (optional):
globalqualityindex --inputdata /path/to/bids_dataset
  1. Run full pipeline in one command (calculation + plotting):
run-megqc   --inputdata /path/to/bids_dataset   --config ./config/settings.ini   --run-all

Launch GUI

megqc

The GUI uses the same backend logic as CLI dispatchers and writes the same derivative/report outputs.

Typical Outputs

MEGqc writes outputs under BIDS derivatives (default):

  • derivatives/Meg_QC/calculation/... (metric tables + JSON summaries)
  • derivatives/Meg_QC/reports/... (interactive HTML reports)
  • derivatives/Meg_QC/... QC summaries including GQI artifacts

Documentation

Source Code

https://github.com/ANCPLabOldenburg/MEGqc

License

MIT License.

Project details


Release history Release notifications | RSS feed

This version

0.7.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meg_qc-0.7.0.tar.gz (488.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meg_qc-0.7.0-py3-none-any.whl (497.5 kB view details)

Uploaded Python 3

File details

Details for the file meg_qc-0.7.0.tar.gz.

File metadata

  • Download URL: meg_qc-0.7.0.tar.gz
  • Upload date:
  • Size: 488.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for meg_qc-0.7.0.tar.gz
Algorithm Hash digest
SHA256 8b1a6d00eb72d8d83d48f4aef403d68652ed298e4a83006c6e59bc8ae519dd3c
MD5 c68a233f8a96a4e7e8d7770999a997e6
BLAKE2b-256 29eef9a3ce71b229c8920caacd31c30e8aecd6da01bd8c8de1c144e250ed3b67

See more details on using hashes here.

File details

Details for the file meg_qc-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: meg_qc-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 497.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for meg_qc-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c941db6b165f82c32596ffe0e5c8279a844952adcd1ea723776943df85e0fe00
MD5 d03dc41f85edf5b2966afb6923725243
BLAKE2b-256 455b9fcc0cd00fc87f338470057b4b18ec659bf34aa1bb0729f8c364037f6c68

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page