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

[FIX] use the proper html template for mutli maps and label masker #4310

Merged
merged 8 commits into from Mar 9, 2024

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Mar 5, 2024

Changes proposed in this pull request:

  • use the appropriate HTML templates for reports of MultiNiftiMapsMasker and MultiNiftiLabelsMasker that would otherwise use the default one.

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 5, 2024

Before: see #4299 (comment)

After:
image

image

Copy link
Contributor

github-actions bot commented Mar 5, 2024

👋 @Remi-Gau Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

  • PR has an interpretable title.
  • PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
  • Code is PEP8-compliant (see our documentation on coding style)
  • Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

  • There is at least one unit test per new function / class (see our documentation on testing)
  • The new feature is demoed in at least one relevant example.

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

Copy link

codecov bot commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.13%. Comparing base (abb80ff) to head (2ef7668).
Report is 25 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4310      +/-   ##
==========================================
+ Coverage   91.85%   92.13%   +0.27%     
==========================================
  Files         144      143       -1     
  Lines       16419    16452      +33     
  Branches     3434     3451      +17     
==========================================
+ Hits        15082    15158      +76     
+ Misses        792      749      -43     
  Partials      545      545              
Flag Coverage Δ
macos-latest_3.10_test_plotting 91.92% <ø> (?)
macos-latest_3.11_test_plotting 91.92% <ø> (+0.07%) ⬆️
macos-latest_3.12_test_plotting 91.92% <ø> (?)
macos-latest_3.8_test_plotting 91.88% <ø> (?)
macos-latest_3.9_test_plotting 91.89% <ø> (?)
ubuntu-latest_3.10_test_plotting 91.92% <ø> (+0.07%) ⬆️
ubuntu-latest_3.11_test_plotting 91.92% <ø> (?)
ubuntu-latest_3.12_test_plotting 91.92% <ø> (?)
ubuntu-latest_3.12_test_pre 91.92% <ø> (?)
ubuntu-latest_3.8_test_min 68.81% <ø> (?)
ubuntu-latest_3.8_test_plot_min 91.59% <ø> (?)
ubuntu-latest_3.8_test_plotting 91.88% <ø> (?)
ubuntu-latest_3.9_test_plotting 91.89% <ø> (?)
windows-latest_3.10_test_plotting 91.90% <ø> (?)
windows-latest_3.11_test_plotting 91.90% <ø> (?)
windows-latest_3.12_test_plotting 91.90% <ø> (?)
windows-latest_3.8_test_plotting 91.86% <ø> (?)
windows-latest_3.9_test_plotting 91.87% <ø> (?)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

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

OK, so this PR is only about the template ?

doc/changes/latest.rst Outdated Show resolved Hide resolved
Co-authored-by: bthirion <bertrand.thirion@inria.fr>
@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 5, 2024

OK, so this PR is only about the template ?

yup, when investigating the root cause of #4299 turns out that report generation would not use the right template for the "multi" maskers and use the default one

Still not a 100% sure why this was only affecting the multimapsmasker and not also the multilabelsmasker, but I have checked the one generated for the latter and could not spot a difference before and after

we can wait till #4295 is in to do a proper check of all the maskers

@Remi-Gau Remi-Gau marked this pull request as ready for review March 5, 2024 21:27
* display masker reports in doc

* update changelog

* refactor

* add notebooks

* clear cells

* [full doc] request full build

* add link to examples

* [full doc] request full build

* fix doc build
@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 6, 2024

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 6, 2024

Actually this DOES fix a bug I had not noticed on the MultiNiftiLabelsMaskers:

The region summary button was not displayed.

Before

image

After

image

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 6, 2024

Messed up the rebase. The number of line changes makes no sense.
Fixing.

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 6, 2024

Note that the next map and previous map button do not seem to cycle through maps when the reports are embedded in the doc. But they work fine in jupyter notebooks.

@Remi-Gau Remi-Gau requested a review from bthirion March 8, 2024 20:26
Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

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

LGTM, thx !

@Remi-Gau Remi-Gau merged commit 58f1258 into nilearn:main Mar 9, 2024
32 of 33 checks passed
@Remi-Gau Remi-Gau deleted the fix/4299 branch March 9, 2024 17:33
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.

[BUG] MultiNiftiMapsMasker reports are empty
2 participants