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.1

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.1.tar.gz (493.5 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.1-py3-none-any.whl (503.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meg_qc-0.7.1.tar.gz
  • Upload date:
  • Size: 493.5 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.1.tar.gz
Algorithm Hash digest
SHA256 c3192f1f62675bdc9d8aaa3938a082335bf00d3b6c0628956c965708eb8e7227
MD5 95e154e036b3fab7afb0cf31982a265b
BLAKE2b-256 b277ee3593e7e89e07313a716ae2046c4b8c4d8aec7aec82ce94ea60a90b901d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meg_qc-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 503.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e8781808bf933f4ad8b2f6f8db404f16530633b139ff2cde699105277d733268
MD5 4a8130de17301f622d4a1edad67dab07
BLAKE2b-256 8d14db7765710d711e698cca3287eb3a48f5d24eece529cb448cb5757cbbd349

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