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

Bring outputs up to date with BEPs 11, 12, 17, and 38 #1065

Merged
merged 46 commits into from
Mar 19, 2024
Merged

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Feb 26, 2024

Changes proposed in this pull request

  • Replace "atlas" entity with "seg" entity in parcellated data. Proposed in BEP 017 and seg is present in BIDS already. I'm still not sold on having both "atlas" and "seg" in BIDS, but "seg" at least is in there.
    • I've retained "atlas" for the actual atlas files.
  • Swap order of space and atlas entities in atlas files, since atlas was removed from BIDS in [SCHEMA][ENH] Remove atlas entity and replace it with seg in prep of BEP038 bids-standard/bids-specification#1579, so the old order is no longer required.
  • Rename connectivity matrices in TSV format from conmat to relmat. Proposed in BEP 017.
  • Rename connectivity matrices in CIFTI format from conmat to boldmap. Proposed in BEP 012.
  • Replace measure entity with stat. Currently planned in BEP 017.
  • Replace alff, reho, and coverage suffixes with stat-<alff|reho|coverage>_bold[map], based on BEP 012. Closes Rename ALFF and ReHo outputs based on BEP 012 #971.
  • Add metadata to relmat files dictated by BEP 017.
    • I didn't add "Code" because I don't think it makes sense to include it.
  • Change extension for desc-linc_qc files from csv to tsv.

References

Documentation that should be reviewed

@tsalo tsalo added the breaking-change PRs that change results or interfaces. label Feb 26, 2024
@tsalo tsalo changed the title Bring outputs up to date with BEPs 17 and 38 Bring outputs up to date with BEPs 11, 12, 17, and 38 Feb 26, 2024
Copy link

codecov bot commented Feb 29, 2024

Codecov Report

Attention: Patch coverage is 98.07692% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.44%. Comparing base (3563e9e) to head (b7537aa).
Report is 109 commits behind head on main.

Files with missing lines Patch % Lines
xcp_d/utils/bids.py 96.29% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1065      +/-   ##
==========================================
+ Coverage   82.29%   82.44%   +0.15%     
==========================================
  Files          48       48              
  Lines        5897     5925      +28     
  Branches      803      812       +9     
==========================================
+ Hits         4853     4885      +32     
+ Misses        844      841       -3     
+ Partials      200      199       -1     

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

@tsalo tsalo added this to the 0.7.0 milestone Mar 1, 2024
@tsalo tsalo requested a review from mattcieslak March 1, 2024 22:33
@tsalo
Copy link
Member Author

tsalo commented Mar 1, 2024

@mattcieslak @kahinimehta would you mind taking a look at the new filenames some time next week to see if they align with your understanding to the relevant BEPs?

Update outputs.rst

Update output documentation.

Fix *another* bug.

Update outputs.py

Update outputs.py

Update bids.py

Update expected outputs.

Add atlases dataset link.

Add dataset_description.json for atlases.

Use BIDS-URI for correlation matrix.
@tsalo tsalo marked this pull request as ready for review March 3, 2024 19:20
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.

I like these BEPs a lot. The new output names I think make sense and are more technically correct than before. Awesome work

@tsalo tsalo merged commit 554c206 into PennLINC:main Mar 19, 2024
20 checks passed
@tsalo tsalo deleted the bep017 branch March 19, 2024 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change PRs that change results or interfaces.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename ALFF and ReHo outputs based on BEP 012
3 participants