A BIDS QC report generator
Project description
CPAC-QC Plotting App
PDF Report
example PDF report here: PDF REPORT
Overview
The CPAC-qc Plotting App is a tool designed to generate quality control plots for the CPAC (Configurable Pipeline for the Analysis of Connectomes) outputs. This app helps in visualizing and assessing the quality of neuroimaging data processed through CPAC.
Updates
- Outputs only PDF report now.
- Default config has overlays.
- Images on PDF report will follow the order mentioned in overlay.csv provided or default.
- Added Bookmarks on PDF report for easy navigation.
Features
- Generate bulk or subject specific plots and reports.
Requirements
- BIDS dir with
.nii.gzimages in it. - PDF viewer
Installation
pip install CPACqc
Usage
- Minimal code
cpacqc -d bids_dir
This will output a pdf report report.pdf in your current directory.
- Providing output dir
cpacqc -d bids_dir -o output_dir
output_dir will be created if not available. Make sure to have write permissions.
- Running single/multiple Subjects
cpacqc -d bids_dir -s subject-id_1 subject-id_2
You can hand pick a single or a multiple subjects with -s flag
- With defined number of procs
cpacqc -d bids_dir -n number-of-procs
Note: if -n is not provided default is 8
- Providing custom Overlays config
cpacqc -d path/to/bids_dir -c ./overlay.csv
where overlay.csv can be in format
output,underlay,datatype
desc-preproc_bold,desc-preproc_T1w,func
and so on. If not provided a default config will be used.
Viewing
Use any PDF viewer to view *report.pdf file.
If -html enabled, Use any .html viewer extension to view index.html in the results dir.
Project details
Release history Release notifications | RSS feed
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cpacqc-0.2.17.tar.gz.
File metadata
- Download URL: cpacqc-0.2.17.tar.gz
- Upload date:
- Size: 8.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.24.1 CPython/3.12.10 Linux/6.11.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
77cc2ccc54aa4b1b12031f020292cc127660294254a71667801996669fb73fca
|
|
| MD5 |
0233d93d7652ec4649f7a5b89b93ba7c
|
|
| BLAKE2b-256 |
9d8a4fc48d643978e6dd8d2c7e6eed4cea5683f90f0305e921f3c43587422e8a
|
File details
Details for the file cpacqc-0.2.17-py3-none-any.whl.
File metadata
- Download URL: cpacqc-0.2.17-py3-none-any.whl
- Upload date:
- Size: 8.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.24.1 CPython/3.12.10 Linux/6.11.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dbd75156f666717f3ba09f37c16d91f7f19342a64d346857d454f3b203391a3f
|
|
| MD5 |
af42ef0c3e8cea9263f1a846e4443928
|
|
| BLAKE2b-256 |
b5b8d8f7ad39eab8b8fb80b6b9b1b7afcd31c723a2a10c0b7b95817dc1a56d3d
|