[FIX] rename contrast_type to stat_type

[Remi-Gau]

• Closes [BUG] inconsistency in the naming  #4186

Changes proposed in this pull request:

• rename parameter contrast_type by stat_type in the function compute_contrast, see https://github.com/nilearn/nilearn/blob/cfc4c03f/nilearn/glm/contrasts.py#L66
• rename attribute contrast_type by stat_type the Contrast class
• apply similar change in downstream private functions

[github-actions]

👋 @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.

[codecov]

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (91e59cc) 92.10% compared to head (137fb35) 92.11%.

Files	Patch %	Lines
nilearn/glm/contrasts.py	87.09%	0 Missing and 4 partials ⚠️
nilearn/glm/_utils.py	80.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4191   +/-   ##
=======================================
  Coverage   92.10%   92.11%           
=======================================
  Files         144      144           
  Lines       16358    16366    +8     
  Branches     3423     3426    +3     
=======================================
+ Hits        15067    15075    +8     
  Misses        752      752           
  Partials      539      539           

Flag	Coverage Δ
macos-latest_3.10_test_plotting	?
macos-latest_3.11_test_plotting	?
macos-latest_3.12_test_plotting	91.89% <86.84%> (+<0.01%)	⬆️
macos-latest_3.9_test_plotting	91.85% <86.84%> (+<0.01%)	⬆️
ubuntu-latest_3.10_test_plotting	91.89% <86.84%> (+<0.01%)	⬆️
ubuntu-latest_3.11_test_plotting	91.89% <86.84%> (+<0.01%)	⬆️
ubuntu-latest_3.12_test_plotting	91.89% <86.84%> (+<0.01%)	⬆️
ubuntu-latest_3.12_test_pre	91.89% <86.84%> (+<0.01%)	⬆️
ubuntu-latest_3.8_test_min	68.99% <86.84%> (+0.01%)	⬆️
ubuntu-latest_3.8_test_plot_min	91.61% <86.84%> (+<0.01%)	⬆️
ubuntu-latest_3.8_test_plotting	91.85% <86.84%> (+<0.01%)	⬆️
ubuntu-latest_3.9_test_plotting	91.85% <86.84%> (+<0.01%)	⬆️
windows-latest_3.10_test_plotting	?
windows-latest_3.11_test_plotting	91.86% <86.84%> (+<0.01%)	⬆️
windows-latest_3.12_test_plotting	?
windows-latest_3.8_test_plotting	91.82% <86.84%> (+<0.01%)	⬆️
windows-latest_3.9_test_plotting	91.83% <86.84%> (+<0.01%)	⬆️

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.

[bthirion]

We'll have to go through deprecation cycles for that one...

[Remi-Gau]

This decorator should take care of the deprecation cycle.

Will add a test to make sure of it.

[Remi-Gau]

@bthirion
for consistency I would also change the attribute contrast_type in the Contrast class.

nilearn/nilearn/glm/contrasts.py

Line 178 in cfc4c03

contrast_type="t",

What do you think?

[bthirion]

Indeed, the idea is to have a uniform naming across classes and functions.

[Remi-Gau]

This is unrelated but came across a directive that did not render in the doc.

https://nilearn.github.io/stable/modules/generated/nilearn.glm.first_level.first_level_from_bids.html#nilearn.glm.first_level.first_level_from_bids

[ymzayek]

Thx @Remi-Gau ! The changes LGTM

[bthirion]

LGTM, thx !