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 logging of component table-based manual classification #852

Merged
merged 5 commits into from
Mar 28, 2022

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Mar 1, 2022

Closes #848.

Changes proposed in this pull request:

  • Add a manual classification step in the four-echo integration test that uses the component table for the classifications.
  • Change the classifications in the five-echo integration test's manual classification step.
  • Add a logger message when a component table is provided.

@tsalo tsalo added documentation issues related to improving documentation for the project testing issues related to improving testing in the project labels Mar 1, 2022
@codecov
Copy link

codecov bot commented Mar 1, 2022

Codecov Report

Merging #852 (64c9f29) into main (eaa0920) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #852   +/-   ##
=======================================
  Coverage   93.27%   93.28%           
=======================================
  Files          27       27           
  Lines        2217     2218    +1     
=======================================
+ Hits         2068     2069    +1     
  Misses        149      149           
Impacted Files Coverage Δ
tedana/workflows/tedana.py 89.96% <100.00%> (+0.03%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eaa0920...64c9f29. Read the comment docs.

@tsalo
Copy link
Member Author

tsalo commented Mar 1, 2022

I'm unable to reproduce the following problem from #848:

the png's in the 'figures' folder created by tedana appear to be unchanged (e.g., a component that was accepted via RICA is still shown as rejected).

First pass

Note that the selected component is ignored.

image

Manual classification

All ignored components were reclassified as accepted in this step, via the component table.

image

@eurunuela
Copy link
Collaborator

I will try to reproduce it sometime this week. I believe we have another user reporting the same issue in Neurostars.

@tsalo
Copy link
Member Author

tsalo commented Mar 8, 2022

@eurunuela it looks like ME-ICA/rica#41 solves the component classification issue, correct? If so, then I think this PR can be reviewed purely as an improvement to documentation/logging.

@eurunuela
Copy link
Collaborator

@eurunuela it looks like ME-ICA/rica#41 solves the component classification issue, correct? If so, then I think this PR can be reviewed purely as an improvement to documentation/logging.

Indeed. I'm sorry I didn't have time to report back, it's been a busy evening.

As you say, we should improve documentation/logging.

@eurunuela
Copy link
Collaborator

#855 should fix a related issue on tedana's side.

Copy link
Collaborator

@eurunuela eurunuela left a comment

Choose a reason for hiding this comment

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

I think these changes should be enough.

Should we add something to the docs? And if so, would you rather do that on this PR or open a new one?

@tsalo
Copy link
Member Author

tsalo commented Mar 16, 2022

I think improving the documentation is a good idea, and I'm happy to incorporate that into this PR. Do you have anything specific in mind?

@handwerkerd handwerkerd self-requested a review March 17, 2022 19:04
Copy link
Member

@handwerkerd handwerkerd left a comment

Choose a reason for hiding this comment

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

LGTM
I don't have any strong opinions on adding documentation here vs a future PR.
My one general concern is how many different things are being tested within some of these integration tests (i.e. manual classification could be a separate test). This is going to create a lot of "fun" when we get to the point of fully reviewing #756 I suspect non-trivial changes to some of these existing tests will be required. It's beyond the scope of this PR, but I'll think about this more, and possibly open up a new issue so that we can start identifying & cleaning up tests that will interface with the modularized decision tree.

@tsalo tsalo merged commit f42ba63 into ME-ICA:main Mar 28, 2022
@tsalo tsalo deleted the fix-manual-selection-logging branch March 28, 2022 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to improving documentation for the project testing issues related to improving testing in the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Denoising with manual classification is not transparent enough
3 participants