snirf-quality-report


Namesnirf-quality-report JSON
Version 0.0.14 PyPI version JSON
download
home_pagehttps://github.com/BUNPC/snirf_quality_report
SummaryGet fNIRS SNIRF raw data quality report
upload_time2022-06-10 20:23:00
maintainer
docs_urlNone
authorSK
requires_python>=3.7.5
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # snirf_quality_report
Generates quality report for fNIRS acquisition data in SNIRF format

### Input
Takes path to SNIRF file located in BIDS folder structure

### Output
Saves quality_report.html and updated channles file in derivatives folder.

### Example
```
from snirf_quality_report.snirf_quality_report import snirf_quality_report

snirf_path = 'path_to_the_snirf_file_insie_a_BIDS_folder'
obj = snirf_quality_report()
obj.run_report(snirf_path)
 
```
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/BUNPC/snirf_quality_report",
    "name": "snirf-quality-report",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.5",
    "maintainer_email": "",
    "keywords": "",
    "author": "SK",
    "author_email": "skura@bu.edu",
    "download_url": "https://files.pythonhosted.org/packages/c6/f9/89f3b08a5d7047cfdd2b87aeef2c3658457233c50d15b06002792d183afd/snirf_quality_report-0.0.14.tar.gz",
    "platform": null,
    "description": "# snirf_quality_report\nGenerates quality report for fNIRS acquisition data in SNIRF format\n\n### Input\nTakes path to SNIRF file located in BIDS folder structure\n\n### Output\nSaves quality_report.html and updated channles file in derivatives folder.\n\n### Example\n```\nfrom snirf_quality_report.snirf_quality_report import snirf_quality_report\n\nsnirf_path = 'path_to_the_snirf_file_insie_a_BIDS_folder'\nobj = snirf_quality_report()\nobj.run_report(snirf_path)\n \n```",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Get fNIRS SNIRF raw data quality report",
    "version": "0.0.14",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b4432843d11ed625ae4375e88294d50b",
                "sha256": "196c169f1dc6d76e90ae03acd74d3c3e03fd35022fdd30e0bc2866bdf9853422"
            },
            "downloads": -1,
            "filename": "snirf_quality_report-0.0.14.tar.gz",
            "has_sig": false,
            "md5_digest": "b4432843d11ed625ae4375e88294d50b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.5",
            "size": 4801,
            "upload_time": "2022-06-10T20:23:00",
            "upload_time_iso_8601": "2022-06-10T20:23:00.242415Z",
            "url": "https://files.pythonhosted.org/packages/c6/f9/89f3b08a5d7047cfdd2b87aeef2c3658457233c50d15b06002792d183afd/snirf_quality_report-0.0.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-10 20:23:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "BUNPC",
    "github_project": "snirf_quality_report",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "snirf-quality-report"
}
        
SK
Elapsed time: 0.46252s