Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bids-standard/pybids-reports

A subpackage of pyBIDS, implementing automatic report generation from BIDS datasets.

https://github.com/bids-standard/pybids-reports

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: nature.com
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary

Keywords

bids brain methods
Last synced: 5 months ago · JSON representation

Repository

A subpackage of pyBIDS, implementing automatic report generation from BIDS datasets.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 6
  • Forks: 2
  • Open Issues: 9
  • Releases: 1
Topics
bids brain methods
Created about 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License

README.md

Run Tests Documentation Status https://github.com/psf/black pre-commit.ci status PyPI - Python Version

pybids-reports

pybids-reports is a subpackage of pyBIDS, implementing automatic report generation from BIDS datasets.

See the BIDS paper and http://bids.neuroimaging.io website for more information.

NOTE: The reports module is experimental and currently under active development, and as such should be used with caution. Please remember to verify any generated report before putting it to use.

Additionally, support for some dataypes (for example EEG or motion) may be limited or missing.

Install

bash pip install pybids-reports

Quickstart

A simple example of standard usage follows. We assume that we have a root folder containing a BIDS-compliant project in /bidsproject.

```python from bids.layout import BIDSLayout from bids.reports import BIDSReport

Load the BIDS dataset

layout = BIDSLayout('/bidsproject')

Initialize a report for the dataset

report = BIDSReport(layout)

Method generate returns a Counter of unique descriptions across subjects

descriptions = report.generate()

For datasets containing a single study design, all but the most common

description most likely reflect random missing data.

pubdescription = descriptions.mostcommon()[0][0] ```

License

pybids-reports is licensed under the terms of the MIT license.

See the file "LICENSE" for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

All trademarks referenced herein are property of their respective holders.

Owner

  • Name: Brain Imaging Data Structure
  • Login: bids-standard
  • Kind: organization

GitHub Events

Total
  • Delete event: 13
  • Issue comment event: 1
  • Push event: 16
  • Pull request review comment event: 1
  • Pull request review event: 1
  • Pull request event: 31
  • Create event: 14
Last Year
  • Delete event: 13
  • Issue comment event: 1
  • Push event: 16
  • Pull request review comment event: 1
  • Pull request review event: 1
  • Pull request event: 31
  • Create event: 14

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 11
  • Average time to close issues: N/A
  • Average time to close pull requests: 14 days
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.09
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 10
Past Year
  • Issues: 0
  • Pull requests: 11
  • Average time to close issues: N/A
  • Average time to close pull requests: 14 days
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.09
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 10
View more stats
Top Authors
Issue Authors
  • Remi-Gau (5)
  • tsalo (2)
Pull Request Authors
  • pre-commit-ci[bot] (25)
  • dependabot[bot] (19)
  • Remi-Gau (9)
  • tsalo (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (19) submodules (16) github_actions (3)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 13 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 2
pypi.org: pybids-reports

pybids-reports: report generator for BIDS datasets

  • Homepage: http://github.com/bids-standard/pybids-reports
  • Documentation: https://pybids-reports.readthedocs.io/en/latest/
  • License: MIT License Copyright (c) 2022 Brain Imaging Data Structure Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.1.0
    published almost 2 years ago
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 13 Last month
Rankings
Dependent packages count: 9.6%
Average: 36.3%
Dependent repos count: 63.1%
Maintainers (2)
tsalo Remi-Gau
Last synced: 6 months ago

Dependencies

.github/workflows/pypi-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/testing.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v3 composite
  • mstachniuk/ci-skip master composite
.github/workflows/testing_cli.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • chevron *
  • nibabel *
  • num2words *
  • pybids >=0.15
  • rich *