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

[ENH] Add verbose outputs for pipeline walkthrough #174

Merged
merged 13 commits into from
Jan 14, 2019

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Jan 5, 2019

Per discussion in #163 (see this comment), this PR adds in outputs necessary for #149.

I will need to update this PR after #152 is dealt with, but am keeping it separate to keep both PRs focused.

Changes proposed in this pull request:

  • Add label, out_dir, and verbose arguments to fitmodels_direct. Fitted models for TEDPCA and TEDICA can thus write out different files.
  • Generate several files with fitmodels_direct, including *_R2_pred.nii, *_S0_pred.nii, *_betas_catd.nii, and *_metric_weights.nii.
    • R2_pred is a 5D array (X x Y x Z x E x C) with the predicted value at each echo and voxel, for each component, for the R2 model.
    • S0_pred is the same, but for the S0 model.
    • metric_weights is a 4D array (X x Y x Z x C) with the voxel- and component-wise weights for averaging the R2 and S0 F values to get component-specific Kappa and Rho values.
    • betas_catd is a 5D (X x Y x Z x E x C) with the beta for the raw data at each echo for each component. These values are compared to the predicted values for the R2 and S0 models in evaluating model fit.
  • Add verbose argument to tedpca.
  • Write out whitened (post-TEDPCA) optimally combined time series.

@codecov
Copy link

codecov bot commented Jan 5, 2019

Codecov Report

Merging #174 into master will decrease coverage by 0.34%.
The diff coverage is 6.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #174      +/-   ##
==========================================
- Coverage   51.98%   51.63%   -0.35%     
==========================================
  Files          32       32              
  Lines        1941     1956      +15     
==========================================
+ Hits         1009     1010       +1     
- Misses        932      946      +14
Impacted Files Coverage Δ
tedana/decomposition/eigendecomp.py 10.52% <ø> (ø) ⬆️
tedana/workflows/tedana.py 11.59% <0%> (-0.18%) ⬇️
tedana/model/fit.py 27.71% <7.69%> (-1.11%) ⬇️

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 69624dc...7b12459. Read the comment docs.

tsalo added 2 commits January 11, 2019 11:08
# Conflicts:
#	tedana/decomposition/eigendecomp.py
#	tedana/workflows/tedana.py
@tsalo
Copy link
Member Author

tsalo commented Jan 11, 2019

It's passing! I think it's ready for review!

Copy link
Member

@emdupre emdupre left a comment

Choose a reason for hiding this comment

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

This is looking good ! I had a few questions. Hope NiMARE is going well !! 👻

docs/_static/plot_optcom.ipynb Outdated Show resolved Hide resolved
tedana/model/fit.py Show resolved Hide resolved
tedana/workflows/tedana.py Outdated Show resolved Hide resolved
@emdupre emdupre merged commit a961cfc into ME-ICA:master Jan 14, 2019
@tsalo tsalo deleted the verbose-outputs branch February 12, 2019 14:16
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.

2 participants