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

bids brain methods

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/bids-standard/pybids-reports
• Owner: bids-standard
• License: mit
• Created: 2022-02-10T21:04:31.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-10-02T07:54:09.000Z (6 months ago)
• Last Synced: 2025-10-02T09:28:13.151Z (6 months ago)
• Topics: bids, brain, methods
• Language: Python
• Homepage: http://pybids-reports.readthedocs.io/
• Size: 1.14 MB
• Stars: 1
• Watchers: 6
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Run Tests](https://github.com/bids-standard/pybids-reports/actions/workflows/testing.yml/badge.svg)](https://github.com/bids-standard/pybids-reports/actions/workflows/testing.yml)

[![Documentation Status](https://readthedocs.org/projects/pybids-reports/badge/?version=latest)](https://pybids-reports.readthedocs.io/en/latest/?badge=latest)

![https://github.com/psf/black](https://img.shields.io/badge/code%20style-black-000000.svg)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/bids-standard/pybids-reports/main.svg)](https://results.pre-commit.ci/latest/github/bids-standard/pybids-reports/main)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nilearn.svg)](https://pypi.org/project/nilearn/)

# pybids-reports

pybids-reports is a subpackage of pyBIDS,

implementing automatic report generation from BIDS datasets.

See the [BIDS paper](http://www.nature.com/articles/sdata201644) 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.

pub_description = descriptions.most_common()[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.