Skip to content

Commit fac9af3

Browse files
committed
fix(docs): remove MNI mentions, add cross-references
1 parent 625813d commit fac9af3

File tree

3 files changed

+13
-17
lines changed

3 files changed

+13
-17
lines changed

docs/citing.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,6 @@ Presentations
250250
Other relevant references
251251
-------------------------
252252

253-
.. [Fonov2011] Fonov VS, Evans AC, Botteron K, Almli CR, McKinstry RC, Collins DL and BDCG,
254-
Unbiased average age-appropriate atlases for pediatric studies, NeuroImage 54(1), 2011
255-
doi:`10.1016/j.neuroimage.2010.07.033 <https://doi.org/10.1016/j.neuroimage.2010.07.033>`_.
256-
257253
.. [Power2017] Power JD, Plitt M, Kundu P, Bandettini PA, Martin A (2017) Temporal interpolation alters
258254
motion in fMRI scans: Magnitudes and consequences for artifact detection. PLOS ONE 12(9): e0182939.
259255
doi:`10.1371/journal.pone.0182939 <https://doi.org/10.1371/journal.pone.0182939>`_.

docs/usage.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Usage
77
As of FMRIPREP 1.0.12, the software includes a tracking system
88
to report usage statistics and errors. Users can opt-out using
99
the ``--notrack`` command line argument.
10-
10+
1111

1212
Execution and the BIDS format
1313
=============================
@@ -38,7 +38,7 @@ Command-Line Arguments
3838
:nodefaultconst:
3939

4040

41-
.. _output_spaces:
41+
.. _output-spaces:
4242

4343
Defining standard and nonstandard spaces where data will be resampled
4444
=====================================================================
@@ -71,9 +71,9 @@ the original data gridding.
7171
However, many users will be interested in utilizing a coarse gridding (typically 2mm isotropic)
7272
of the target template.
7373
Such a behavior can be achieved applying modifiers to the template identifier, separated by
74-
a ``:`` character.
74+
a ``:`` character.
7575
For instance, ``--output-spaces MNI152NLin6Asym:res-2 MNI152NLin2009cAsym`` will generate
76-
preprocessed BOLD 4D files on two standard spaces (``MNI152NLin6Asym``,
76+
preprocessed BOLD 4D files on two standard spaces (``MNI152NLin6Asym``,
7777
and ``MNI152NLin2009cAsym``) with the template's 2mm isotropic resolution for
7878
the data on ``MNI152NLin6Asym`` space and the original BOLD resolution
7979
(say, e.g., 2x2x2.5 [mm]) for the case of ``MNI152NLin2009cAsym``.
@@ -116,7 +116,7 @@ Additionally, ``--output-spaces`` accepts identifiers of spatial references
116116
that do not generate *standardized* coordinate spaces:
117117

118118
* ``T1w`` or ``anat``: data are resampled into the individual's anatomical
119-
reference generated with the T1w and T2w images available within the
119+
reference generated with the T1w and T2w images available within the
120120
BIDS structure.
121121
* ``fsnative``: similarly to the ``anat`` space for volumetric references,
122122
including the ``fsnative`` space will instruct fMRIPrep to sample the
@@ -189,7 +189,7 @@ make your data available within that system first.
189189

190190
For instance, here at the Poldrack Lab we use Stanford's
191191
:abbr:`HPC (high-performance computing)` system, called Sherlock.
192-
Sherlock enables `the following data transfer options
192+
Sherlock enables `the following data transfer options
193193
<https://www.sherlock.stanford.edu/docs/user-guide/storage/data-transfer/>`_.
194194

195195
Alternatively, more comprehensive solutions such as `Datalad

docs/workflows.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Brain extraction, brain tissue segmentation and spatial normalization
9191
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9292

9393
Then, the T1w reference is skull-stripped using a Nipype implementation of
94-
the ``antsBrainExtraction.sh`` tool (ANTs), which is an atlas-based
94+
the ``antsBrainExtraction.sh`` tool (ANTs), which is an atlas-based
9595
brain extraction workflow:
9696

9797
.. workflow::
@@ -120,7 +120,7 @@ Once the brain mask is computed, FSL ``fast`` is utilized for brain tissue segme
120120

121121
Finally, spatial normalization to standard spaces is performed using ANTs' ``antsRegistration``
122122
in a multiscale, mutual-information based, nonlinear registration scheme.
123-
See `output_spaces`_ for information about how standard and nonstandard spaces can
123+
See :ref:`output-spaces` for information about how standard and nonstandard spaces can
124124
be set to resample the preprocessed data onto the final output spaces.
125125

126126

@@ -143,9 +143,9 @@ in the same space and resolution as the T1 image, and follow the naming conventi
143143
(e.g. ``sub-001_T1w_label-lesion_roi.nii.gz``).
144144
This file should be placed in the ``sub-*/anat`` directory of the BIDS dataset
145145
to be run through *fMRIPrep*.
146-
Because lesion masks are not currently part of the BIDS specification, it is also necessary to
147-
include a ``.bidsignore`` file in the root of your dataset directory. This will prevent
148-
`bids-validator <https://github.com/bids-standard/bids-validator#bidsignore>`_ from complaining that your dataset not BIDS valid, which prevents
146+
Because lesion masks are not currently part of the BIDS specification, it is also necessary to
147+
include a ``.bidsignore`` file in the root of your dataset directory. This will prevent
148+
`bids-validator <https://github.com/bids-standard/bids-validator#bidsignore>`_ from complaining that your dataset not BIDS valid, which prevents
149149
*fMRIPrep* from running. Your ``.bidsignore`` file should include the following line::
150150

151151
*lesion_roi.nii.gz
@@ -491,7 +491,7 @@ This sub-workflow concatenates the transforms calculated upstream (see
491491
fieldmaps are available--, `EPI to T1w registration`_, and an anatomical-to-standard
492492
transform from `T1w/T2w preprocessing`_) to map the :abbr:`EPI (echo-planar imaging)`
493493
image to the standard spaces given by the ``--output-spaces`` argument (see
494-
`output_spaces`_.
494+
:ref:`output-spaces`.
495495
It also maps the T1w-based mask to each of those standard spaces.
496496

497497
Transforms are concatenated and applied all at once, with one interpolation (Lanczos)
@@ -560,7 +560,7 @@ ICA-AROMA
560560

561561
ICA-AROMA denoising is performed in ``MNI152NLin6Asym`` space, which is automatically
562562
added to the list of ``--output-spaces`` if it was not already requested by the user.
563-
The number of ICA-AROMA components depends on a dimensionality estimate made by
563+
The number of ICA-AROMA components depends on a dimensionality estimate made by
564564
FSL MELODIC.
565565
For datasets with a very short TR and a large number of timepoints, this may result
566566
in an unusually high number of components.

0 commit comments

Comments
 (0)