Skip to main content

pybids-reports: report generator for BIDS datasets

Project description

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

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, only MRI datatypes (func, anat, fmap, and dwi) are currently supported.

Quickstart

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

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.

Copyright (c) 2016--, PyBIDS developers, Planet Earth

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybids_reports-0.1.0.tar.gz (73.9 kB view details)

Uploaded Source

Built Distribution

pybids_reports-0.1.0-py3-none-any.whl (90.3 kB view details)

Uploaded Python 3

File details

Details for the file pybids_reports-0.1.0.tar.gz.

File metadata

  • Download URL: pybids_reports-0.1.0.tar.gz
  • Upload date:
  • Size: 73.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.3

File hashes

Hashes for pybids_reports-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b269ab9e085d2ec67388f954c031fb337c3dea033999b0e5baab8829ab28b236
MD5 92f983e98e4748d94cf1f04d34a9a977
BLAKE2b-256 141c929c6cdbbd8267ddb94537a1a57fcfe8672710953777c9dc5bd1e154a92e

See more details on using hashes here.

Provenance

File details

Details for the file pybids_reports-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pybids_reports-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7e8938ad2a9802eb43d16efbebc50d4346446621f87685985e8e02e16b7890d
MD5 b5ef936ca8005d495ec396937730d0d6
BLAKE2b-256 e2829d9476efb4617f07c45ea49561a42d06147195b7ec1495308750125f71bb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page