Giter VIP home page Giter VIP logo

qap's Introduction

QAP BIDS Application

Documentation

Extensive information can be found in the Quality Assessment Protocol webpage.

Description

Various objective measures for MRI data quality have been proposed over the years. However, until now no software has allowed researchers to obtain all these measures in the same place with relative ease. The Quality Assessment Protocol package allows you to obtain spatial and anatomical data quality measures for your own data. Reports can optionally be generated that provide a variety of data visualizations to aid with quality assessment.

This container calculates dataset level quality assessment metrics of structural and functional MRI data when run in "participant" mode and compiles the outputs of many different participants outputs into single CSV files when run in "group" mode.

Usage

This App has the following command line arguments:

usage: run.py [-h]
              [--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]
              [--pipeline_file PIPELINE_FILE] [--n_cpus N_CPUS] [--mem MEM]
              [--save_working_dir] [--report]
              bids_dir output_dir {participant,group}

PCP-QAP Pipeline Runner

positional arguments:
  bids_dir              The directory with the input dataset formatted
                        according to the BIDS standard.
  output_dir            The directory where the output CSV files should be
                        stored.
  {participant,group}   Level of the analysis that will be performed. Multiple
                        participant level analyses can be run independently
                        (in parallel) using the same output_dir. Group level
                        analysis compiles multiple participant level quality
                        metrics intogroup-level csv files.

optional arguments:
  -h, --help            show this help message and exit
  --participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]
                        The label of the participant that should be analyzed.
                        The label corresponds to sub-<participant_label> from
                        the BIDS spec (so it does not include "sub-"). If this
                        parameter is not provided all subjects should be
                        analyzed. Multiple participants can be specified with
                        a space separated list.
  --pipeline_file PIPELINE_FILE
                        Name for the pipeline configuration file to use, uses
                        a default configuration if not specified
  --n_cpus N_CPUS       Number of execution resources available for the
                        pipeline, default=1
  --mem MEM             Amount of RAM available to the pipeline in GB, default
                        = 6
  --save_working_dir    Save the contents of the working directory.
  --report              Generates pdf for graphically assessing data quality.

To run it in participant level mode (for one participant):

docker run -i --rm \
    -v /Users/filo/data/ds005:/bids_dataset \
    -v /Users/filo/outputs:/outputs \
    bids-apps/qap:v1.0.0 \
    /bids_dataset /outputs --participant_label 01 participant

To run all subjects and generate the group level analysis report:

docker run -i --rm \
    -v /Users/filo/data/ds005:/bids_dataset \
    -v /Users/filo/outputs:/outputs \
    bids-apps/qap:v1.0.0 \
    /bids_dataset /outputs group

Reporting errors and getting help

Please report errors on the QAP github page issue tracker. Please use the PCP google group for help using C-PAC and this application.

Acknowledgements

We currently have a publication in preparation, in the meantime please cite our poster from INCF:

Shehzad Z, Giavasis S, Li Q, Benhajali Y, Yan C, Yang Z, Milham M, Bellec P
and Craddock C (2015). The Preprocessed Connectomes Project Quality
Assessment Protocol - a resource for measuring the quality of MRI data..
Front. Neurosci. Conference Abstract: Neuroinformatics 2015. doi:
10.3389/conf.fnins.2015.91.00047

@ARTICLE{shehzad2015,
    AUTHOR={Shehzad, Zarrar  and  Giavasis, Steven  and  Li, Qingyang  and
      Benhajali, Yassine  and  Yan, Chaogan  and  Yang, Zhen  and  Milham,
      Michael  and  Bellec, Pierre  and  Craddock, Cameron},
    TITLE={The Preprocessed Connectomes Project Quality Assessment Protocol
     - a resource for measuring the quality of MRI data.},
    JOURNAL={Frontiers in Neuroscience},
    VOLUME={},
    YEAR={},
    NUMBER={47},
    URL={http://www.frontiersin.org/neuroscience/10.3389/conf.fnins.2015.91.00047/full},
    DOI={10.3389/conf.fnins.2015.91.00047},
    ISSN={1662-453X} ,
    ABSTRACT={}
 }

qap's People

Contributors

carolfrohlich avatar ccraddock avatar chrisgorgo avatar pre-commit-ci[bot] avatar remi-gau avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

qap's Issues

absence of command line options overrides provided pipeline.yml

the pipeline file is loaded before the command line options are parsed, leading to the fact that absence of a command line option --report for instance, overriding the settings in a specified pipeline file.

One solution would be a disclaimer to use either the command line options OR provide a pipeline file.

Another would be to add a line re-loading the pipeline_file if not equal to /qap_resources/default.yml

Cannot build image with latest version of ubuntu

Older version of ubuntu have package version conflicts:

https://app.circleci.com/pipelines/github/bids-apps/QAP/8/workflows/4d4d3856-a621-4e85-ab89-d3b55699edc0/jobs/24

Switching to the latest version comes with other problem

https://app.circleci.com/pipelines/github/bids-apps/QAP/9/workflows/20054f83-2382-426d-8cdb-87b0f472ee77/jobs/25

Sending build context to Docker daemon  557.1kB
Sending build context to Docker daemon  2.955MB


Step 1/19 : FROM ubuntu:jammy
jammy: Pulling from library/ubuntu


6e3729cf69e0: Pulling fs layer 

6e3729cf69e0: Downloading  311.7kB/30.43MB

6e3729cf69e0: Downloading  14.02MB/30.43MB

6e3729cf69e0: Downloading  24.23MB/30.43MB

6e3729cf69e0: Verifying Checksum 

6e3729cf69e0: Download complete 

6e3729cf69e0: Extracting  327.7kB/30.43MB

6e3729cf69e0: Extracting  5.243MB/30.43MB

6e3729cf69e0: Extracting  8.847MB/30.43MB

6e3729cf69e0: Extracting  13.43MB/30.43MB

6e3729cf69e0: Extracting  19.66MB/30.43MB

6e3729cf69e0: Extracting  25.23MB/30.43MB

6e3729cf69e0: Extracting  26.87MB/30.43MB

6e3729cf69e0: Extracting  30.15MB/30.43MB

6e3729cf69e0: Extracting  30.43MB/30.43MB

6e3729cf69e0: Pull complete 
Digest: sha256:27cb6e6ccef575a4698b66f5de06c7ecd61589132d5a91d098f7f3f9285415a9
Status: Downloaded newer image for ubuntu:jammy
 ---> 6b7dfa7e8fdb
Step 2/19 : ARG DEBIAN_FRONTEND="noninteractive"
 ---> Running in 239e345aba27
Removing intermediate container 239e345aba27
 ---> 2692932c6f52
Step 3/19 : ENV AFNIPATH /opt/afni/bin/
 ---> Running in a31bcfb90d96
Removing intermediate container a31bcfb90d96
 ---> 7a9482d1dd82
Step 4/19 : ENV PATH /code:/opt/afni/bin:/usr/local/bin/miniconda/bin:${PATH}
 ---> Running in c37b1f4411fe
Removing intermediate container c37b1f4411fe
 ---> d92c6efc0868
Step 5/19 : RUN apt-get update -qq &&     apt-get install -q --no-install-recommends -y             wget             pkg-config             graphviz             gsl-bin             libexpat1-dev             libgiftiio-dev             libglu1-mesa             libglu1-mesa-dev             libgsl0-dev             libjpeg-progs             libxml2             libxml2-dev             libxext-dev             libxpm-dev             libxp6             libxp-dev             mesa-common-dev             mesa-utils             netpbm             libpng-dev             libfreetype6-dev             libxml2-dev             libxslt1-dev             python-dev             build-essential             g++             libxft2             git &&     apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 ---> Running in 39f13a17b367
Reading package lists...
Building dependency tree...
Reading state information...
Package python-dev is not available, but is referred to by another package.
This may mean that the package is missing, has been obsoleted, or
is only available from another source
However the following packages replace it:
  python2-dev python2 python-dev-is-python3

E: Unable to locate package libxp6
E: Unable to locate package libxp-dev
E: Package 'python-dev' has no installation candidate
The command '/bin/sh -c apt-get update -qq &&     apt-get install -q --no-install-recommends -y             wget             pkg-config             graphviz             gsl-bin             libexpat1-dev             libgiftiio-dev             libglu1-mesa             libglu1-mesa-dev             libgsl0-dev             libjpeg-progs             libxml2             libxml2-dev             libxext-dev             libxpm-dev             libxp6             libxp-dev             mesa-common-dev             mesa-utils             netpbm             libpng-dev             libfreetype6-dev             libxml2-dev             libxslt1-dev             python-dev             build-essential             g++             libxft2             git &&     apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*' returned a non-zero code: 100

Exited with code exit status 100

Dockerfile error on line 24

Docker build fails if line 24=
RUN pip install nipype nibabel nitime pyyaml pandas seaborn html5lib==1.0b8 pyPdf2 xhtml2pdf indi-tools

Instead, it should say: RUN pip install nipype nibabel nitime pyyaml pandas seaborn html5lib==1.0b10 pyPdf2 xhtml2pdf indi-tools

QAP runs out of space inside docker

Giving QAP a list of subjects, say 20 or so, crashes when the docker runs out of space, presumably due to writing internally to /tmp.
I can get around this by specifying:
-v /tmp:/tmp
in my docker run call, but is this actually the problem or is it something else?
(Double-posting to BIDS-Apps/QAP and preprocessed-connectomes-project/quality-assessment-protocol)

QAP Image Not Found

I'm having some trouble running bids-apps/qap and I noticed on the bids apps homepage (http://bids-apps.neuroimaging.io/apps/) that the image is not found. This is also the error I'm getting when I'm trying to run the program through the terminal. Any suggestions for a fix?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.