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

Adding elbow & variance information to the reports #764

Open
handwerkerd opened this issue Jul 22, 2021 · 2 comments
Open

Adding elbow & variance information to the reports #764

handwerkerd opened this issue Jul 22, 2021 · 2 comments
Labels
effort: medium Theoretically <40h total work enhancement issues describing possible enhancements to the project good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. impact: low Improving code/documentation cleanliness/clarity, not function priority: low issues that are not urgent reports issues related to boilerplate generation or visual reports

Comments

@handwerkerd
Copy link
Member

Summary

There are a few additional bits of information that would be useful to add to the reports. I'll list a few here.

Additional Detail

  • Add elbow thresholds to the sorted kappa & rho plots so that people can see which components fell above & below the elbows. Also may how when the elbow calculations were a bit odd compared to other datasets in a study. I'm not sure the elbow criteria are currently being recorded anywhere
  • Add total variance explained by the PCA/ICA as well as the total variance explained by the Accepted, Ignored, & Rejected components. I've found these numbers to be really useful to highlight a weird subject in a data set. All these values are in a combination of the tedana_[date].tsv log and can be summed from the values in ica_metrics.tsv

Next Steps

  • Decide were we want to store numbers that aren't linked to a specific component. In the original me-ica, there was a header for the ICA component metrics table that included this information, but we got rid of that at some point. Should we make a tsv or json file that can currently contain a few summary values and can be expanded to include more?
  • Store the elbow info somewhere and add a few markers to the reports
  • Calculate the variance summations and identify where in the tedana html report we want to display that info
  • While working on this, any other summary numbers we should store & display?
@handwerkerd handwerkerd added enhancement issues describing possible enhancements to the project good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. priority: low issues that are not urgent reports issues related to boilerplate generation or visual reports effort: medium Theoretically <40h total work impact: low Improving code/documentation cleanliness/clarity, not function labels Jul 22, 2021
@handwerkerd
Copy link
Member Author

The elbow information will be added when #756 is merged, so that part of this issue will be resolved. Adding the variance info to the reports would require a few more changes.

@tsalo
Copy link
Member

tsalo commented Apr 27, 2024

If we want to report variance explained by PCA and ICA, we should also report variance explained by global signal (when used).

We can write out a run-level TSV for info like this. I'd go with that over a JSON because it should be easier to aggregate over runs/subjects. XCP-D does something similar with desc-linc_qc.tsv (which has QC metrics for each run).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: medium Theoretically <40h total work enhancement issues describing possible enhancements to the project good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. impact: low Improving code/documentation cleanliness/clarity, not function priority: low issues that are not urgent reports issues related to boilerplate generation or visual reports
Projects
None yet
Development

No branches or pull requests

2 participants