Skip to content

Commit b9008a5

Browse files
oestebanyarikoptic
andcommitted
enh: complete suggestions from @yarikoptic
Related-to: nipreps/nipreps.github.io#47 (comment) Co-authored-by: Yaroslav Halchenko <[email protected]>
1 parent b85b5e3 commit b9008a5

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/source/usage.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ tip and troubleshooting guidelines for both
1919
`Singularity or Apptainer <https://www.nipreps.org/apps/singularity/>`__.
2020
In addition to container-specific guidelines, the documentation
2121
also includes specific
22-
`help for processing DataLad-managed datasets <https://www.nipreps.org/apps/datalad/>`__
22+
`help for processing DataLad-managed datasets <https://www.nipreps.org/apps/datalad/>`__.
2323

2424
The rest of this documentation page applies to both *bare-metal*
2525
and containerized execution modes.
@@ -86,6 +86,22 @@ in :ref:`The MRIQC Reports <reports>`.
8686
In the ``group`` level, the :abbr:`IQMs (image quality metrics)` extracted in
8787
first place are combined in a table and the group reports are generated.
8888

89+
*MRIQC* can fetch data in *DataLad* datasets
90+
--------------------------------------------
91+
As of *MRIQC* 22.0.3, the application bundles *DataLad*, enabling automatic
92+
data fetching in *DataLad* datasets.
93+
Employing this feature in containerized environments may lead to
94+
somewhat obscure errors (see, for example,
95+
`nipreps/mriqc#1307 <https://github.com/nipreps/mriqc/issues/1307>`__).
96+
If you intend to use *DataLad* datasets, please read carefully
97+
*NiPreps*' `help for processing DataLad-managed datasets <https://www.nipreps.org/apps/datalad/>`__.
98+
99+
Alternatively, this feature can be disabled by adding
100+
``--no-datalad-get`` to the command line.
101+
This will separate *DataLad* management from *MRIQC*'s operation,
102+
which can be an effective way of debugging issues and averting
103+
fault conditions.
104+
89105
Command line interface
90106
----------------------
91107
.. argparse::

0 commit comments

Comments
 (0)