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, FIX, RF] Fix typos in documentation and refactor fit_decay/fit_decay_ts. #49

Merged
merged 19 commits into from
May 15, 2018

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented May 14, 2018

After the build succeeded, I noticed a couple of typos. Namely:

  • Intersphinx links to nibabel were not working
  • tedana.workflows description was incorrect
  • Some docstrings used np.ndarray instead of numpy.ndarray, breaking intersphinx links

TomMaullin and others added 9 commits May 11, 2018 16:24
Rather than manually inputting the dimensionality of the input data,
check automatically.

Also, I originally made a mistake in checking the shape of the data. I
guess data should be inputted in 3D form (SxExT) rather than 5D
(XxYxZxExT)
@tsalo tsalo changed the title [DOC, FIX] Fix typos in documentation. [DOC, FIX, RF] Fix typos in documentation and refactor fit_decay/fit_decay_ts. May 14, 2018
@tsalo
Copy link
Member Author

tsalo commented May 14, 2018

I should have held off on merging @TomMaullin's PR, but I forgot about this one, so both sets of changes (the doc fix and the fit_decay refactor) have been mushed together in one PR. Sorry about that!

@emdupre
Copy link
Member

emdupre commented May 14, 2018

Nice ! Is this ready for review ?

@tsalo
Copy link
Member Author

tsalo commented May 14, 2018

Yeah, it's ready.

t2saf_ts[:, :, :, vol] = t2saf
s0vaf_ts[:, :, :, vol] = s0vaf

[t2sa, s0va, _, _, t2saf, s0vaf] = fit_decay(
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about converting this to, instead of calling fit_decay inside of fit_decay_ts, being able to throw a timeseries=True flag ?

Copy link
Member

Choose a reason for hiding this comment

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

@TomMaullin if you'd like to address this in a different PR, I can merge this one and leave #25 open !

Copy link
Member

Choose a reason for hiding this comment

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

Personally, I think it would be good to leave that to a separate PR! This ones looks good to me 😄

Copy link
Contributor

@TomMaullin TomMaullin May 16, 2018

Choose a reason for hiding this comment

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

Hi @emdupre , @rmarkello

Sorry for the delayed response! Would you still like me to address this or has it now been taken care of?

Copy link
Member

Choose a reason for hiding this comment

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

Sorry for my delayed response ! I went ahead and merged this PR, but #25 is still open with the idea of eventually refactoring so that we could pass a timeseries=True argument or something similar. If you're interested in taking that on, we'd love to have your contribution !!

@emdupre
Copy link
Member

emdupre commented May 14, 2018

Thanks ! I do have one specific question about how we're refactoring fit_decay and fit_decay_ts. Otherwise, LGTM !

@emdupre
Copy link
Member

emdupre commented May 14, 2018

And I added a merge conflict from #41 😓

tsalo and others added 3 commits May 14, 2018 17:41
# Conflicts:
#	tedana/model/monoexponential.py
Took the wrong merge commit !
@codecov
Copy link

codecov bot commented May 15, 2018

Codecov Report

Merging #49 into master will increase coverage by 0.34%.
The diff coverage is 0%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #49      +/-   ##
==========================================
+ Coverage   23.02%   23.37%   +0.34%     
==========================================
  Files          23       23              
  Lines        1355     1335      -20     
==========================================
  Hits          312      312              
+ Misses       1043     1023      -20
Impacted Files Coverage Δ
tedana/utils/utils.py 79.74% <ø> (ø) ⬆️
tedana/model/fit.py 8.08% <ø> (ø) ⬆️
tedana/decomposition/eigendecomp.py 0% <ø> (ø) ⬆️
tedana/model/combine.py 19.23% <ø> (ø) ⬆️
tedana/model/monoexponential.py 8.51% <0%> (+2.54%) ⬆️

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 d47294e...7623ce3. Read the comment docs.

@emdupre
Copy link
Member

emdupre commented May 15, 2018

This is passing, despite the coverage warning ! Opened #53 to fix this for future PRs.

@rmarkello
Copy link
Member

🎉 it passes! Sorry for the headache of merge conflicts caused by integrating #41... These updates look great! The docs are coming along handily 👍

@emdupre
Copy link
Member

emdupre commented May 15, 2018

LGTM ! Merging ! @TomMaullin I'll keep #25 open, too 😄

@emdupre emdupre merged commit c1c3f3c into ME-ICA:master May 15, 2018
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.

4 participants