mrQA


NamemrQA JSON
Version 0.3 PyPI version JSON
download
home_pageNone
SummaryrQA suite of tools offering automatic evaluation of protocol compliance
upload_time2024-04-10 19:45:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords protocol compliance quality assurance
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            mrQA : automatic protocol compliance checks on MR datasets
=============================================================

.. image:: https://img.shields.io/pypi/v/mrQA.svg
        :target: https://pypi.python.org/pypi/mrQA

.. image:: https://app.codacy.com/project/badge/Grade/8cd263e1eaa0480d8fac50eba0094401
        :target: https://app.codacy.com/gh/sinhaharsh/mrQA/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade

.. image:: https://github.com/sinhaharsh/mrQA/actions/workflows/continuous-integration.yml/badge.svg
        :target: https://github.com/sinhaharsh/mrQA/actions/workflows/continuous-integration.yml


.. image:: https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg
        :target: https://nbviewer.org/github/Open-Minds-Lab/mrQA/blob/master/examples/usage.ipynb


----

Documentation: https://open-minds-lab.github.io/mrQA/

----

``mrQA`` is a tool developed for automatic evaluation of protocol compliance in MRI datasets. The tool analyzes MR acquisition data from DICOM headers and compares it against protocol to determine the level of compliance. It takes as input a dataset in DICOM/BIDS format. The tool outputs a compliance report in HTML format, with a percent compliance score for each sequence/modality in a dataset. The tool also outputs a JSON file with the compliance scores for each modality. In addition, it highlights any deviations from the protocol. The tool has been specifically created keeping in mind those who directly acquired the data such as MR Physicists and Technologists, but can be used by anyone who wants to evaluate that MR scans are acquired according to a pre-defined protocol and to minimize errors in acquisition process.

``mrQA`` uses ``MRDataset`` to efficiently parse various neuroimaging dataset formats, which is available `here <github.com/Open-Minds-Lab/MRdataset>`_.

Key features:

- evaluation of protocol compliance (within-sequence across-dataset) in an existing dataset
- continuous monitoring of incoming data (hourly or daily on XNAT server or similar)
- parallel processing of very large datasets (like ABCD or UK Biobank) on a HPC cluster
- few more to be released soon including vertical audit within-session across-sequence checks

Simple schematic of the library:

.. image:: ./docs/schematic_mrQA.png






            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mrQA",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "protocol compliance, quality assurance",
    "author": null,
    "author_email": "Pradeep Reddy Raamana <raamana@gmail.com>, Harsh Sinha <harsh.sinha@pitt.edu>",
    "download_url": "https://files.pythonhosted.org/packages/b0/b6/2c74e617fc9345cfef5652f18c369b2ba90ae97a36f634f0bd761ad310a1/mrQA-0.3.tar.gz",
    "platform": null,
    "description": "mrQA : automatic protocol compliance checks on MR datasets\n=============================================================\n\n.. image:: https://img.shields.io/pypi/v/mrQA.svg\n        :target: https://pypi.python.org/pypi/mrQA\n\n.. image:: https://app.codacy.com/project/badge/Grade/8cd263e1eaa0480d8fac50eba0094401\n        :target: https://app.codacy.com/gh/sinhaharsh/mrQA/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade\n\n.. image:: https://github.com/sinhaharsh/mrQA/actions/workflows/continuous-integration.yml/badge.svg\n        :target: https://github.com/sinhaharsh/mrQA/actions/workflows/continuous-integration.yml\n\n\n.. image:: https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg\n        :target: https://nbviewer.org/github/Open-Minds-Lab/mrQA/blob/master/examples/usage.ipynb\n\n\n----\n\nDocumentation: https://open-minds-lab.github.io/mrQA/\n\n----\n\n``mrQA`` is a tool developed for automatic evaluation of protocol compliance in MRI datasets. The tool analyzes MR acquisition data from DICOM headers and compares it against protocol to determine the level of compliance. It takes as input a dataset in DICOM/BIDS format. The tool outputs a compliance report in HTML format, with a percent compliance score for each sequence/modality in a dataset. The tool also outputs a JSON file with the compliance scores for each modality. In addition, it highlights any deviations from the protocol. The tool has been specifically created keeping in mind those who directly acquired the data such as MR Physicists and Technologists, but can be used by anyone who wants to evaluate that MR scans are acquired according to a pre-defined protocol and to minimize errors in acquisition process.\n\n``mrQA`` uses ``MRDataset`` to efficiently parse various neuroimaging dataset formats, which is available `here <github.com/Open-Minds-Lab/MRdataset>`_.\n\nKey features:\n\n- evaluation of protocol compliance (within-sequence across-dataset) in an existing dataset\n- continuous monitoring of incoming data (hourly or daily on XNAT server or similar)\n- parallel processing of very large datasets (like ABCD or UK Biobank) on a HPC cluster\n- few more to be released soon including vertical audit within-session across-sequence checks\n\nSimple schematic of the library:\n\n.. image:: ./docs/schematic_mrQA.png\n\n\n\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "rQA suite of tools offering automatic evaluation of protocol compliance",
    "version": "0.3",
    "project_urls": {
        "Documentation": "https://open-minds-lab.github.io/mrQA/",
        "Homepage": "https://github.com/Open-Minds-Lab/mrQA"
    },
    "split_keywords": [
        "protocol compliance",
        " quality assurance"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cad4bc8278fc9e1a6403120338fd27ad6329461b9b4eaa9cd5c1bc3e162e21b7",
                "md5": "4017f50c77b415c0e7089161f532ce5d",
                "sha256": "2f43f662d4d86c544b179760f25b82202185eccc4c1253d2e3ed497f58f3e858"
            },
            "downloads": -1,
            "filename": "mrqa-0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4017f50c77b415c0e7089161f532ce5d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9982694,
            "upload_time": "2024-04-10T19:45:02",
            "upload_time_iso_8601": "2024-04-10T19:45:02.017938Z",
            "url": "https://files.pythonhosted.org/packages/ca/d4/bc8278fc9e1a6403120338fd27ad6329461b9b4eaa9cd5c1bc3e162e21b7/mrqa-0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b0b62c74e617fc9345cfef5652f18c369b2ba90ae97a36f634f0bd761ad310a1",
                "md5": "cc8ce95eab850a4193ce11110cd7256c",
                "sha256": "d03dacd2ba6aba8f7092a1c63c9e49fd781730b36143464e58dcc389cdf54dfb"
            },
            "downloads": -1,
            "filename": "mrQA-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "cc8ce95eab850a4193ce11110cd7256c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 9964607,
            "upload_time": "2024-04-10T19:45:10",
            "upload_time_iso_8601": "2024-04-10T19:45:10.956969Z",
            "url": "https://files.pythonhosted.org/packages/b0/b6/2c74e617fc9345cfef5652f18c369b2ba90ae97a36f634f0bd761ad310a1/mrQA-0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-10 19:45:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Open-Minds-Lab",
    "github_project": "mrQA",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "mrqa"
}
        
Elapsed time: 0.21440s