diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 202150a6..c85bb2b3 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -19,7 +19,7 @@ tip and troubleshooting guidelines for both `Singularity or Apptainer `__. In addition to container-specific guidelines, the documentation also includes specific -`help for processing DataLad-managed datasets `__ +`help for processing DataLad-managed datasets `__. The rest of this documentation page applies to both *bare-metal* and containerized execution modes. @@ -86,6 +86,21 @@ in :ref:`The MRIQC Reports `. In the ``group`` level, the :abbr:`IQMs (image quality metrics)` extracted in first place are combined in a table and the group reports are generated. +*MRIQC* can fetch data in *DataLad* datasets +-------------------------------------------- +As of *MRIQC* 22.0.3, the application bundles *DataLad*, enabling automatic +data fetching in *DataLad* datasets. +Employing this feature in containerized environments may lead to +somewhat obscure errors (see, for example, +`nipreps/mriqc#1307 `__. +If you intend to use *DataLad* datasets, please read carefully +*NiPreps*' `help for processing DataLad-managed datasets `__. + +Alternatively, this feature can be disabled by adding +``--no-datalad-get`` to the command line. +This will separate *DataLad* management from *MRIQC*'s operation, +which can be an effective way of debugging and averting these issues. + Command line interface ---------------------- .. argparse::