A BIDS app for performing minimal QC beyond validation
Project description
miniQC
miniQC is a BIDS App for performing minimal quality control beyond validation. Its goal is to rapidly detect data corruption, as opposed to dataset coherence or image quality.
Table of Contents
Installation
pip install miniqc
Usage
miniqc
is a BIDS-App, so can be run
as follows:
miniqc /path/to/dataset /output participant
Because miniqc does not currently generate any outputs or modify its behavior based on analysis level, output directory and analysis level are optional.
This tool is meant as a CLI application and does not provide a public API.
Example
$ miniqc tests/data/bids_dataset
[
[
"sub-01/anat/sub-01_acq-truncated_T2w.nii.gz",
"FailedCheck",
"Expected 477 bytes; found 352"
],
[
"sub-01/anat/sub-01_acq-dangling_T2w.nii.gz",
"FileNotFoundError",
"[Errno 2] No such file or directory: 'tests/data/bids_dataset/sub-01/anat/sub-01_acq-dangling_T2w.nii.gz'"
]
]
Single file usage is also permitted:
$ miniqc tests/data/bids_dataset/sub-01/anat/sub-01_acq-truncated_T2w.nii.gz
[
[
"/git/miniqc/tests/data/bids_dataset/sub-01/anat/sub-01_acq-truncated_T2w.nii.gz",
"FailedCheck",
"Expected 477 bytes; found 352"
]
]
Outputs
The output of this tool is a JSON array of arrays, each of length 3. Each sub-array contains the failed file (relative to dataset root), the type of error, and a message with more detail.
Testing
With the hatch project management tool installed:
hatch run test:cov
Alternately, just run pytest
, although you will need the dependencies installed.
License
miniqc
is distributed under the terms of the MIT license.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file miniqc-23.1.1.tar.gz
.
File metadata
- Download URL: miniqc-23.1.1.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9201f0a5b14f54ad489e674f30a44cbe610abf88ce967b399f0cc365334b984c |
|
MD5 | a7948c7b32282fdb188eb8262d36e0e8 |
|
BLAKE2b-256 | 0eee1feeb82c6f645778bbd2f3b018e5fc66164c48bc2b92d17e6ccfe521bb98 |
File details
Details for the file miniqc-23.1.1-py3-none-any.whl
.
File metadata
- Download URL: miniqc-23.1.1-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ac62a6b7e1295aa92461518ab4824eaa0630de19a52c6069ac03569e42b86b3 |
|
MD5 | 22de9f53644243ee4a5650210f36b306 |
|
BLAKE2b-256 | 5c20eda8d9824004477aec921cff6de7809529c863ab24e65b3f16fdd8659706 |