temp

[github-actions[bot]]

👋 @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.
• [x] PR links to Github issue with mention "Closes #XXXX"
• [ ] Code is PEP8-compliant.
• [x] Changelog or what's new entry in "doc/changes/latest.rst"
• [ ] (Bug fixes) There is at least one test that would fail under the original bug conditions.
• [ ] (New features) There is at least one unit test per new function / class.
• [x] (New features) The new feature is demoed in at least one relevant example.

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

[ghost]

Review on Crocodile

[sourcery-ai[bot]]

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 0.25%.

Quality metrics	Before	After	Change
Complexity	3.17 ⭐	3.04 ⭐	-0.13 👍
Method Length	112.62 🙂	112.50 🙂	-0.12 👍
Working memory	9.20 🙂	9.15 🙂	-0.05 👍
Quality	63.32% 🙂	63.57% 🙂	0.25% 👍

Other metrics	Before	After	Change
Lines	1792	2000	208

Changed files	Quality Before	Quality After	Quality Change
nilearn/decomposition/__init__.py	98.83% ⭐	98.83% ⭐	0.00%
nilearn/decomposition/_base.py	56.85% 🙂	57.66% 🙂	0.81% 👍
nilearn/decomposition/_multi_pca.py	64.67% 🙂	64.67% 🙂	0.00%
nilearn/decomposition/canica.py	51.17% 🙂	51.20% 🙂	0.03% 👍
nilearn/decomposition/dict_learning.py	62.73% 🙂	62.73% 🙂	0.00%
nilearn/decomposition/tests/test_base.py	56.47% 🙂	58.01% 🙂	1.54% 👍
nilearn/decomposition/tests/test_canica.py	73.98% 🙂	73.98% 🙂	0.00%
nilearn/decomposition/tests/test_dict_learning.py	70.66% 🙂	70.66% 🙂	0.00%
nilearn/decomposition/tests/test_multi_pca.py	63.36% 🙂	63.16% 🙂	-0.20% 👎
nilearn/maskers/base_masker.py	52.53% 🙂	52.53% 🙂	0.00%

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
nilearn/maskers/base_masker.py	_filter_and_extract	13 🙂	325 ⛔	16 ⛔	31.10% 😞	Try splitting into smaller methods. Extract out complex expressions
nilearn/decomposition/_base.py	_mask_and_reduce	14 🙂	240 ⛔	14 😞	35.96% 😞	Try splitting into smaller methods. Extract out complex expressions
nilearn/decomposition/canica.py	CanICA.__init__	2 ⭐	168 😞	32 ⛔	43.36% 😞	Try splitting into smaller methods. Extract out complex expressions
nilearn/decomposition/dict_learning.py	DictLearning.__init__	0 ⭐	167 😞	35 ⛔	45.21% 😞	Try splitting into smaller methods. Extract out complex expressions
nilearn/decomposition/canica.py	CanICA._unmix_components	11 🙂	272 ⛔	9 🙂	45.70% 😞	Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[codecov-commenter]

Codecov Report

Merging #2 (0cb1d65) into main (00a87e3) will increase coverage by 0.01%. The diff coverage is 86.88%.

@@            Coverage Diff             @@
##             main       #2      +/-   ##
==========================================
+ Coverage   90.94%   90.96%   +0.01%     
==========================================
  Files         133      133              
  Lines       15335    15332       -3     
  Branches     3024     3022       -2     
==========================================
  Hits        13947    13947              
+ Misses        820      819       -1     
+ Partials      568      566       -2     

Impacted Files	Coverage Δ
nilearn/maskers/base_masker.py	83.95% <ø> (ø)
nilearn/decomposition/dict_learning.py	89.06% <72.72%> (ø)
nilearn/decomposition/canica.py	91.66% <80.00%> (ø)
nilearn/decomposition/_base.py	94.87% <91.89%> (+1.79%)	:arrow_up:
nilearn/decomposition/__init__.py	100.00% <100.00%> (ø)
nilearn/decomposition/_multi_pca.py	100.00% <100.00%> (ø)

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