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

[DOC] Improve warnings for BIDS folders #4253

Merged
merged 4 commits into from Feb 8, 2024
Merged

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Feb 1, 2024

Changes proposed in this pull request:

  • indicate folder where subjects were not found
  • increase stack level of several warnings
  • add error when no subject was found
  • use absolute path

Copy link
Contributor

github-actions bot commented Feb 1, 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.

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Feb 1, 2024

@michellewang

let me know if this makes sense

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Feb 1, 2024

example output of a failed run

/home/remi/github/origami/cohort_creator/demo/code/run_glm.py:16: UserWarning: 
Subject label aa is not present in the following dataset and cannot be processed:
 /home/remi/github/origami/cohort_creator/demo/outputs/study-ds000208/derivatives/fmriprep-21.0.2
  ) = first_level_from_bids(
Traceback (most recent call last):
  File "/home/remi/github/origami/cohort_creator/demo/code/run_glm.py", line 16, in <module>
    ) = first_level_from_bids(
        ^^^^^^^^^^^^^^^^^^^^^^
  File "/home/remi/github/nilearn/nilearn/nilearn/glm/first_level/first_level.py", line 1403, in first_level_from_bids
    raise RuntimeError(f"\nNo subject found in:\n {derivatives_path}")
RuntimeError: 
No subject found in:
 /home/remi/github/origami/cohort_creator/demo/outputs/study-ds000208/derivatives/fmriprep-21.0.2

Copy link

codecov bot commented Feb 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8d0ef5b) 92.06% compared to head (fade2c8) 92.06%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4253   +/-   ##
=======================================
  Coverage   92.06%   92.06%           
=======================================
  Files         144      144           
  Lines       16419    16423    +4     
  Branches     3434     3435    +1     
=======================================
+ Hits        15116    15120    +4     
  Misses        761      761           
  Partials      542      542           
Flag Coverage Δ
macos-latest_3.10_test_plotting 91.85% <100.00%> (?)
macos-latest_3.11_test_plotting 91.85% <100.00%> (+<0.01%) ⬆️
macos-latest_3.12_test_plotting ?
macos-latest_3.8_test_plotting 91.81% <100.00%> (+<0.01%) ⬆️
macos-latest_3.9_test_plotting 91.82% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.10_test_plotting 91.85% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.11_test_plotting 91.85% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.12_test_plotting 91.85% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.12_test_pre 91.85% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.8_test_min 68.95% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.8_test_plot_min 91.56% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.8_test_plotting 91.81% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.9_test_plotting 91.82% <100.00%> (+<0.01%) ⬆️
windows-latest_3.10_test_plotting 91.83% <100.00%> (+<0.01%) ⬆️
windows-latest_3.11_test_plotting 91.83% <100.00%> (+<0.01%) ⬆️
windows-latest_3.12_test_plotting 91.83% <100.00%> (+<0.01%) ⬆️
windows-latest_3.8_test_plotting 91.79% <100.00%> (+<0.01%) ⬆️
windows-latest_3.9_test_plotting 91.80% <100.00%> (+<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.

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.

Did not sport any issue. Thx !

@michellewang
Copy link
Contributor

@michellewang
let me know if this makes sense

Realized that I forgot to get back to you 😅 but yes the error message looks good to me!

@Remi-Gau Remi-Gau merged commit 1c90f3f into nilearn:main Feb 8, 2024
32 checks passed
@Remi-Gau Remi-Gau deleted the warning_bids branch February 8, 2024 09:03
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.

improve warning for data folder in first_level_from_bids
3 participants