nireports

The NiPreps' Reporting and Visualization system - report templates and "reportlets"

https://github.com/nipreps/nireports

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
  • Committers with academic emails
    2 of 17 committers (11.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary

Keywords

brain-imaging neuroimaging nipreps qc quality-control reporting visualization

Keywords from Contributors

quality-reporter mri bids dataflow-programming dataflow brainweb fmri-preprocessing fmri workflow-engine closember
Last synced: 6 months ago · JSON representation

Repository

The NiPreps' Reporting and Visualization system - report templates and "reportlets"

Basic Info
Statistics
  • Stars: 10
  • Watchers: 4
  • Forks: 20
  • Open Issues: 21
  • Releases: 14
Topics
brain-imaging neuroimaging nipreps qc quality-control reporting visualization
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Zenodo

README.rst

.. image:: https://img.shields.io/pypi/v/nireports.svg
  :target: https://pypi.python.org/pypi/nireports/
  :alt: Latest Version
.. image:: https://img.shields.io/badge/License-Apache_2.0-blue.svg
  :target: https://github.com/nipreps/eddymotion/blob/main/LICENSE
  :alt: License
.. image:: https://readthedocs.org/projects/nireports/badge/?version=latest
  :target: https://nireports.readthedocs.io/en/latest/?badge=latest
  :alt: Documentation Status
.. image:: https://circleci.com/gh/nipreps/nireports/tree/main.svg?style=shield
  :target: https://circleci.com/gh/nipreps/nireports/tree/main
  :alt: Testing
.. image:: https://github.com/nipreps/nireports/actions/workflows/build_test_deploy.yml/badge.svg
  :target: https://github.com/nipreps/nireports/actions/workflows/build_test_deploy.yml
  :alt: Build-Test-Deploy
.. image:: https://codecov.io/gh/nipreps/nireports/branch/main/graph/badge.svg?token=OPH6D32GWN
  :target: https://codecov.io/gh/nipreps/nireports

*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.

Owner

  • Name: NeuroImaging PREProcessing toolS
  • Login: nipreps
  • Kind: organization
  • Email: nipreps@gmail.com

GitHub Events

Total
  • Create event: 17
  • Release event: 3
  • Issues event: 10
  • Watch event: 3
  • Delete event: 6
  • Issue comment event: 128
  • Push event: 48
  • Pull request review event: 80
  • Pull request review comment event: 60
  • Pull request event: 95
  • Fork event: 1
Last Year
  • Create event: 17
  • Release event: 3
  • Issues event: 10
  • Watch event: 3
  • Delete event: 6
  • Issue comment event: 128
  • Push event: 48
  • Pull request review event: 80
  • Pull request review comment event: 60
  • Pull request event: 95
  • Fork event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 509
  • Total Committers: 17
  • Avg Commits per committer: 29.941
  • Development Distribution Score (DDS): 0.593
Past Year
  • Commits: 150
  • Committers: 8
  • Avg Commits per committer: 18.75
  • Development Distribution Score (DDS): 0.573
Top Committers
Name Email Commits
Oscar Esteban c****e@o****s 207
Christopher J. Markiewicz e****s@g****m 122
Jon Haitz Legarreta Gorroño j****a@g****m 34
Zvi Baratz z****z@g****m 23
Dimitri Papadopoulos 3****s 21
Mathias Goncalves g****s@g****m 17
Teresa Gomez 4****g 15
Taylor Salo t****6@f****u 13
Elodie Savary e****y@o****m 13
Krzysztof J. Gorgolewski k****i@g****m 11
NiPreps Bot n****s@g****m 11
dependabot[bot] 4****] 7
Ross Blair r****2@s****u 6
Shoshana Berleant s****r 4
Céline Provins c****s@u****h 3
Ariel Rokem a****m@g****m 1
mnoergaard m****d@n****k 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 54
  • Total pull requests: 179
  • Average time to close issues: 5 months
  • Average time to close pull requests: 14 days
  • Total issue authors: 11
  • Total pull request authors: 14
  • Average comments per issue: 1.43
  • Average comments per pull request: 1.93
  • Merged pull requests: 138
  • Bot issues: 0
  • Bot pull requests: 14
Past Year
  • Issues: 7
  • Pull requests: 94
  • Average time to close issues: 4 days
  • Average time to close pull requests: 5 days
  • Issue authors: 3
  • Pull request authors: 7
  • Average comments per issue: 0.0
  • Average comments per pull request: 2.02
  • Merged pull requests: 67
  • Bot issues: 0
  • Bot pull requests: 8
Top Authors
Issue Authors
  • oesteban (24)
  • ZviBaratz (12)
  • jhlegarreta (4)
  • celprov (3)
  • tsalo (3)
  • eilidhmacnicol (2)
  • effigies (2)
  • mnoergaard (2)
  • mgxd (1)
  • dkp (1)
Pull Request Authors
  • jhlegarreta (69)
  • effigies (39)
  • oesteban (32)
  • DimitriPapadopoulos (19)
  • dependabot[bot] (18)
  • ZviBaratz (12)
  • tsalo (11)
  • celprov (5)
  • esavary (3)
  • rwblair (3)
  • mgxd (3)
  • teresamg (2)
  • mnoergaard (2)
  • arokem (1)
Top Labels
Issue Labels
enhancement (22) bug (14) good first issue (3) impact: high (3) documentation (3) effort: high (2) effort: medium (2) impact: medium (1) visual reports system (1) help wanted (1) effort: low (1)
Pull Request Labels
dependencies (18) github_actions (4) documentation (3) bug (2) enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 23,974 last-month
  • Total dependent packages: 5
  • Total dependent repositories: 1
  • Total versions: 19
  • Total maintainers: 3
pypi.org: nireports

NiReports - The Visual Report System (VRS) of NiPreps

  • Versions: 19
  • Dependent Packages: 5
  • Dependent Repositories: 1
  • Downloads: 23,974 Last month
Rankings
Downloads: 3.1%
Dependent packages count: 3.2%
Forks count: 9.6%
Average: 11.8%
Dependent repos count: 21.5%
Stargazers count: 21.6%
Maintainers (3)
Last synced: 6 months ago

Dependencies

.github/workflows/build_test_deploy.yml actions
  • actions/cache/restore v3 composite
  • actions/cache/save v3 composite
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • codecov/codecov-action v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.maint/requirements.txt pypi
  • click *
  • fuzzywuzzy *
pyproject.toml pypi
  • importlib_resources python_version < "3.9"
  • matplotlib >= 3.4.2
  • nibabel >= 3.0.1
  • nilearn >= 0.5.2
  • nipype *
  • numpy *
  • pandas *
  • pybids *
  • pyyaml *
  • seaborn *
  • svgutils >= 0.3.4
  • templateflow *
.github/workflows/contrib.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pre-commit/action v3.0.1 composite