-
Notifications
You must be signed in to change notification settings - Fork 296
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: Improving accessibility of confounds description #1877
Conversation
Thanks for opening this pull request! It looks like this is your first time contributing to fMRIPrep. 😄 "name": "Contributor, New FMRIPrep",
"affiliation": "Department of fMRI prep'ing, Open Science Made-Up University",
"orcid": "<your id>"
}, ```
Of course, if you want to opt-out this time there is no problem at all with adding your name later. You will be always welcome to add it in the future whenever you feel it should be listed. |
This comment has been minimized.
This comment has been minimized.
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.
Looking great at a first pass. Documentation build is failing because of the FSL link, added a suggestion to fix that.
A couple of iterated issues that I only marked once:
- New sentences should start with new lines
- fMRIPrep should be capitalized that way, and rendered in italics: fMRIPrep.
Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
Co-Authored-By: Oscar Esteban <code@oscaresteban.es>
…/poldracklab/fmriprep into docs/confounds_desc_acessibility
Co-Authored-By: William Hedley Thompson <wiheto@users.noreply.github.com>
…klab/fmriprep into docs/confounds_desc_acessibility
Okay, rendered here https://10602-53175327-gh.circle-artifacts.com/0/tmp/src/fmriprep/docs/_build/html/outputs.html Last call for @rciric and @poldracklab/fmriprep-docusprint-leaders to have a look. |
docs/outputs.rst
Outdated
and ``global_signal`` to enable applying 36-parameter denoising strategy | ||
proposed by Satterthwaite et al. [Satterthwaite2013]_. | ||
|
||
Derivatives and quadratic terms are stored under column names with suffixes: ``_derivative1`` and powers ``_power2``. |
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.
We should probably note that these are not BIDS-Derivatives-Draft conformant and subject to change in future versions.
Co-Authored-By: Chris Markiewicz <markiewicz@stanford.edu>
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.
Thanks for the feedback - will address your mutually exclusive comments later.
|
||
.. warning:: | ||
If you are already using ICA-AROMA cleaned data (``~desc-smoothAROMAnonaggr_bold.nii.gz``), | ||
do not include ICA-AROMA confounds during your design specification or denoising procedure. |
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.
Yes
"SingularValue": 25.8270209974, | ||
"VarianceExplained": 0.1081970825 | ||
}, | ||
"dropped_0": { |
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.
Paging @rciric
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.
Overall, looks great. My comments are super nitpicky so take them with a grain of salt!
…r organization
DOC: Refinement of confounds documentation after #1877
Changes proposed in this pull request
This PR addresses issues #489 #1726 #1049 related to improving the accessibility and educational value of fMRIPrep documentation, in particular, description of Confounds.
The work was done during fMRIPrep docusprint and is a result of collaborative effort of multiple people, including Pierre Bellec, Elizabeth DuPre, Karolina Finc, James Kent, Chris Markiewicz, Saren Seeley, Ursula Tooley, Hao-Ting Wang.
You can track our discussion here:
https://docs.google.com/document/d/14WyhCvEn0G5fbLY-Rk7BQa9ISzYEB2ll3YCjyd-OjB8/edit
Documentation that should be reviewed
We made major edits to the Confounds subsection in
outputs.rst
:confounds_regressors.tsv
table, such as (1) regressing out all confounds during denoising procedure, (2) using ICA-AROMA confounds on AROMA-denoised data, and (3) not selecting a subset of CompCor confounds;There is still much to improve and clarify, but I think that this is a good start.