Skip to main content

A BIDS QC report generator

Project description

PyPI Downloads PyPI Version Build Status License: MIT Python Versions

CPAC-QC Plotting App

PDF Report

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.gz images in it.
  • PDF viewer

Installation

pip install CPACqc

Usage

  1. Minimal code
cpacqc -d bids_dir

This will output a pdf report report.pdf in your current directory.

  1. Providing output dir
cpacqc -d bids_dir -o output_dir

output_dir will be created if not available. Make sure to have write permissions.

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

  1. With defined number of procs
cpacqc -d bids_dir  -n number-of-procs

Note: if -n is not provided default is 8

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


Download files

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

Source Distribution

cpacqc-0.2.18.tar.gz (8.3 MB view details)

Uploaded Source

Built Distribution

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

cpacqc-0.2.18-py3-none-any.whl (8.3 MB view details)

Uploaded Python 3

File details

Details for the file cpacqc-0.2.18.tar.gz.

File metadata

  • Download URL: cpacqc-0.2.18.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

Hashes for cpacqc-0.2.18.tar.gz
Algorithm Hash digest
SHA256 f302d9f8df84932b22c2a97e05b04a5a7b95fadee32a57f221632068e613dac0
MD5 0385795240cdde7bdb439a5551afe6ed
BLAKE2b-256 4ae34c229a185bf19860d5e35de55d109c01515f987092a1fcf4901bfd22bde2

See more details on using hashes here.

File details

Details for the file cpacqc-0.2.18-py3-none-any.whl.

File metadata

  • Download URL: cpacqc-0.2.18-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

Hashes for cpacqc-0.2.18-py3-none-any.whl
Algorithm Hash digest
SHA256 1d5919e0bd2f8276b009d934f5f2500bc4a927f9e30cbcb2f2e988667ffbf7f6
MD5 e5835c4911918eb2ff96c640b6e63bd9
BLAKE2b-256 67be307528a9c0f4dc75392d20d57b194fd975172be2e15b04f197ca34e5a72e

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