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

Add options to subset atlases #1034

Merged
merged 29 commits into from
Jan 19, 2024
Merged

Add options to subset atlases #1034

merged 29 commits into from
Jan 19, 2024

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Jan 16, 2024

Closes #995.

Changes proposed in this pull request

  • Add two mutually exclusive command-line parameters, --skip-parcellation and --atlases, to control which atlases are used for parcellation.
    • --skip-parcellation will set the atlases parameter to an empty list ([]), so that no atlases are used for parcellation, and the parcellation workflow doesn't happen.
    • --atlases will set the atlases parameter. Users can provide a space-separated list of which atlases they actually want to use. The default is to use all of the atlases in XCP-D.

Documentation that should be reviewed

@tsalo tsalo added the enhancement New feature or request label Jan 16, 2024
Copy link
Contributor

@mattcieslak mattcieslak left a comment

Choose a reason for hiding this comment

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

This looks great. One question - is using atlases more intuitive for you than atlas_names? It's ultimately being used as an atlas ID

@tsalo
Copy link
Member Author

tsalo commented Jan 17, 2024

This looks great. One question - is using atlases more intuitive for you than atlas_names? It's ultimately being used as an atlas ID

Thanks! I think atlases makes more sense as a command-line parameter, since it's shorter and equally clear. I used atlas_names in internal functions before because they weren't user-facing, but since now atlases will be what users see in the command line, I want to make the variable names consistent throughout the package.

Copy link

codecov bot commented Jan 19, 2024

Codecov Report

Attention: Patch coverage is 96.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 82.51%. Comparing base (b93205e) to head (7a53363).
Report is 139 commits behind head on main.

Files with missing lines Patch % Lines
xcp_d/interfaces/connectivity.py 71.42% 1 Missing and 1 partial ⚠️
xcp_d/workflows/cifti.py 66.66% 0 Missing and 2 partials ⚠️
xcp_d/workflows/bold.py 83.33% 0 Missing and 1 partial ⚠️
xcp_d/workflows/concatenation.py 94.73% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##           main    #1034       +/-   ##
=========================================
+ Coverage      0   82.51%   +82.51%     
=========================================
  Files         0       48       +48     
  Lines         0     5846     +5846     
  Branches      0      786      +786     
=========================================
+ Hits          0     4824     +4824     
- Misses        0      826      +826     
- Partials      0      196      +196     

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

@tsalo tsalo marked this pull request as ready for review January 19, 2024 18:29
@tsalo tsalo merged commit 673efa3 into PennLINC:main Jan 19, 2024
20 checks passed
@tsalo tsalo deleted the select-atlases branch January 19, 2024 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow users to run workflow with a subset of the atlases
2 participants