NiReports - The Visual Report System (VRS) of NiPreps

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for cjmarkie from gravatar.com cjmarkie Avatar for mgxd from gravatar.com mgxd Avatar for nipreps from gravatar.com nipreps Avatar for oesteban from gravatar.com oesteban
Meta

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: Apache-2.0
    SPDX License Expression
  • Requires: Python >=3.9
  • Provides-Extra: all, dev, doc, docs, test, tests, types
Classifiers

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.

Supported by

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