Skip to main content

NiReports - The Visual Report System (VRS) of NiPreps

Project description

Latest Version License Documentation Status Testing Build-Test-Deploy https://codecov.io/gh/nipreps/nireports/branch/main/graph/badge.svg?token=OPH6D32GWN

NiReports: the NiPreps’ reporting and visualization tools

NiReports contains the two main components of the visual reporting system of NiPreps:

  • Reportlets: visualizations for assessing the quality of a particular processing step within the neuroimaging pipeline. Typically, reportlets show brain mosaics perhaps with contours and/or segmentations. They can be dynamic and flicker between two different states to help assess the accuracy of image registrations. However, the reportlets are not limited to brain mosaics, and can contain correlation plots, BOLD fMRI carpetplots, etc.

  • Assembler: end-user NiPreps write out reportlets to a predetermined folder, which is then queried by the assembler using PyBIDS. The assembler follows a report specification in YAML format, which states the query to find specific reportlets and their corresponding metadata and text annotations. As a result, one HTML file with a concatenation of reportlets is produced.

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

nireports-24.0.3.tar.gz (77.2 MB view details)

Uploaded Source

Built Distribution

nireports-24.0.3-py3-none-any.whl (44.3 MB view details)

Uploaded Python 3

File details

Details for the file nireports-24.0.3.tar.gz.

File metadata

  • Download URL: nireports-24.0.3.tar.gz
  • Upload date:
  • Size: 77.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nireports-24.0.3.tar.gz
Algorithm Hash digest
SHA256 1c3cc31cfaa386f0fef73a24f1376070e5d2c6aae9ca5daae89f78c6d1e65d39
MD5 ead2ac56e8aa08c7294b3b4fbfdc29cd
BLAKE2b-256 ffba97a972892bbdea73d04b58a359b261fae55b1545fa7788b5f3db519d6d3c

See more details on using hashes here.

File details

Details for the file nireports-24.0.3-py3-none-any.whl.

File metadata

  • Download URL: nireports-24.0.3-py3-none-any.whl
  • Upload date:
  • Size: 44.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nireports-24.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 45cbd8da1fd7ce18299050e513e46e69b7f0dac3a325370fcf48aa3a863cd308
MD5 5b373ed33605b7a80a10f16b4e498e91
BLAKE2b-256 6b24dccec9e687c5567e32efea1e1eec7080bd82c2f85c438a148d65e3f7c677

See more details on using hashes here.

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