-
Notifications
You must be signed in to change notification settings - Fork 95
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
Multiple documentation updates #948
Multiple documentation updates #948
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #948 +/- ##
=======================================
Coverage 89.00% 89.00%
=======================================
Files 27 27
Lines 3411 3411
Branches 622 622
=======================================
Hits 3036 3036
Misses 227 227
Partials 148 148 ☔ View full report in Codecov by Sentry. |
@all-contributors please add @handwerkerd for code. |
I've put up a pull request to add @handwerkerd! 🎉 |
I think I've included all the open low-hanging-fruit documentation open issues. There are a few others that might take a bit more work and are sufficiently separate from the rest of these. It would be good to get reviews from both people who know what's happening under the hood and people who can see if I'm explaining things clearly. While you're reading, also keep an eye out for other simple things that could be written more clearly or have added info. @tsalo @eurunuela @dowdlelt @n-reddy @NaomiGaggi @marco7877 You can view the rendered documentation for this PR at: https://tedana--948.org.readthedocs.build/en/948/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There might be a small typo, but LGTM otherwise.
Co-authored-by: Taylor Salo <tsalo90@gmail.com>
docs/faq.rst
Outdated
exclude voxels from some steps that have large dropout in later echoes. The adaptive | ||
mask will flag some voxels in common dropout regions, but should not radically alter | ||
the inputted mask. Here is more information on the | ||
`creation and use of the adaptive mask`_. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't recall - is the original input mask still used as the mask for the final data (even if the ICA is run on a reduced mask due to drop out).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All voxels with at least 1 good echo are included. The revised text clarifies this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
github is being finicky...I approve pending typo corrections
a typo that my suggestion didn't fix
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I abused my powers to fix a typo, because honestly it feels like kind of insane to point at a typo, say I approve, get that dismissed, then approve again. I approve!
Closes #683. Closes #898. Closes #900. Closes #942
This will be a PR to address many of the open issues regarding documentation. As I address more, I'll update this initial message. Others are welcome to work on documentation issues/gap and add to this PR.
Changes proposed in this pull request:
fmrwhy
inmulti-echo.rst
(Add fmrwhy to multi-echo resources #683)multi-echo.rst
(follow-up to Add recommendations for distortion correction #896)approach.rst
and added "Why are there so few voxels in my mask?" tofaq.rst
(Improve documentation on masking options #898)outputs.rst
ica-components-report. Also linking to the new interactive demo from OHBM2023. (Re-do interactive reports demo in documentation #942)approach.rst
and as a issue to look for when looking at time series in the reports inoutputs.rst
"individual-component-view" (Mention dropping non-steady-state volumes in documentation #900)