Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Allow different types of reportlets, not only BIDS-based #60

Merged
merged 16 commits into from
Mar 21, 2023

Conversation

oesteban
Copy link
Member

@oesteban oesteban commented Mar 15, 2023

Adds two new types of reportlets:

  • metadata, which basically renders an input dictionary (possibly nested) formatted as a table (instead of just receiving a ".html" reportlet).
  • custom, which currently hard-wires two subtypes of custom reportlets: the error summary and the boilerplate.

Limitations:

  • the interface of the metadata reportlets is still unclear, will continue defining it in the future with the migration of MRIQC
  • the configurations of custom reportlets are a bit clunky, but I believe they still add flexibility over what we had.

Extra:

Examples:

Towards: #57.

@codecov-commenter
Copy link

codecov-commenter commented Mar 15, 2023

Codecov Report

Patch coverage: 92.74% and project coverage change: +3.46 🎉

Comparison is base (95dff6d) 51.50% compared to head (dff5659) 54.97%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #60      +/-   ##
==========================================
+ Coverage   51.50%   54.97%   +3.46%     
==========================================
  Files          17       17              
  Lines        1689     1788      +99     
  Branches      337      359      +22     
==========================================
+ Hits          870      983     +113     
+ Misses        743      728      -15     
- Partials       76       77       +1     
Flag Coverage Δ
unittests 54.62% <92.55%> (+3.35%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
nireports/assembler/tools.py 31.25% <ø> (ø)
nireports/assembler/report.py 90.90% <86.66%> (+10.72%) ⬆️
nireports/assembler/reportlet.py 92.85% <94.11%> (+3.96%) ⬆️
nireports/assembler/misc.py 79.76% <95.65%> (+24.65%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@oesteban oesteban marked this pull request as ready for review March 19, 2023 18:57
@oesteban oesteban requested review from celprov and effigies March 20, 2023 16:04
@oesteban oesteban force-pushed the enh/57-reportlets-types branch from 6ed679e to 1b9f397 Compare March 20, 2023 18:12
Copy link
Member

@effigies effigies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The overall changes to the reporting code are very difficult to assess. Reviewing test_report.py, the changes to the API seem like manageable generalizations.

I have reviewed the three sample reports in the CircleCI output, and they appear reasonable.

One small comment about a function that I couldn't quickly work out the behavior of by reading the code.

nireports/assembler/misc.py Outdated Show resolved Hide resolved
@oesteban oesteban force-pushed the enh/57-reportlets-types branch from 86bb37c to dff5659 Compare March 21, 2023 11:14
@oesteban
Copy link
Member Author

Beefed up documentation and coverage, not limited to the unfold_columns() function. Merging -- thanks for the feedback!

@oesteban oesteban merged commit 2048300 into main Mar 21, 2023
@oesteban oesteban deleted the enh/57-reportlets-types branch March 21, 2023 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants