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

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.6.8.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.6.8-py3-none-any.whl (497.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meg_qc-0.6.8.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.6.8.tar.gz
Algorithm Hash digest
SHA256 0b4bcdfb8877247c6df8ab25e938bcae36861c03a87aa2ea8981384c8693d6b1
MD5 cd9c0efab649535598c7703c01ce4f2f
BLAKE2b-256 9a0eaccd53d3b555c42932c593dac8741c83fc269c17b7755ff0da539f3d361b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meg_qc-0.6.8-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.6.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4e0492a3313601d614b2afd7e04772117c8b1fc89da0c122404a748599c5ea88
MD5 2f5d80f677f18826e744037fd4b2ff46
BLAKE2b-256 dd543fd410d1f1b5c93abb07d31051f2654880f76ee30029a24e1410c5d28aad

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