[ENH] use contrast number in contrast filename

[Remi-Gau]

Summary by Sourcery

Enhancements:

• Adds the contrast number to the filename of the result files.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request modifies the filename generation logic to include the contrast number when available. This change ensures that contrast numbers are included in the generated filenames, improving organization and traceability.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added contrast number to filename.	Added a conditional statement to check for the existence of the contrastNb field in the result struct. If the field exists, the contrast number is formatted as a four-digit string with leading zeros and added to the nameSpec.entities.label field.	src/stats/results/returnResultNameSpec.m

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Remi-Gau - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a unit test to verify the correct formatting of the contrast number in the filename.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.76%. Comparing base (f53979a) to head (e0b8cb6).
Report is 169 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1347      +/-   ##
==========================================
+ Coverage   79.57%   81.76%   +2.18%     
==========================================
  Files         285      284       -1     
  Lines        7742     7748       +6     
  Branches       40        0      -40     
==========================================
+ Hits         6161     6335     +174     
+ Misses       1565     1413     -152     
+ Partials       16        0      -16     

Flag	Coverage Δ
cli	?
macos-13_matlab-R2023b_fast	63.33% <66.66%> (?)
macos-13_matlab-R2023b_slow	58.67% <100.00%> (?)
macos-latest_matlab-R2023a_fast	?
macos-latest_matlab-R2023a_slow	?
octave	76.57% <100.00%> (+0.85%)	⬆️
ubuntu-latest_matlab-R2023a_fast	?
ubuntu-latest_matlab-R2023a_slow	?
ubuntu-latest_matlab-R2023b_fast	63.33% <66.66%> (?)
ubuntu-latest_matlab-R2023b_slow	59.16% <100.00%> (?)
windows-latest_matlab-R2023b_fast	63.33% <66.66%> (?)
windows-latest_matlab-R2023b_slow	58.67% <100.00%> (?)

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.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[marcobarilari]

I had a quick check (I guess you know already but writing here a memo) and it seems at least in the moae demo that the label-contrastNb is not assigned because it is missing in the result structure.

Hardcoding result.contrastNb = 1; in here makes it work. I can try myself to move on but need some pointer or a hint on how to proceed.

[Remi-Gau]

in CI the montage figure seems to have the label in the filename: https://github.com/cpp-lln-lab/bidspm/actions/runs/13524807083/job/37793493598?pr=1347#step:14:1087

I need to update CI so we can download and inspect the output of demo

[marcobarilari]

makes sensed, indeed the montage and thresholded mask are named with the label but not the nidm or the table and glass brain page and it might be because those renamed take the contast nb from a different place compared to the other resutls (fixed by manually updatin result.contrastNb = 1)

[Remi-Gau]

yup: spend quite a bit of time trying to fix that yesterday but I did not find a clean way to fix that