Skip to content
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.

Sign up for GitHub

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: Add --index-metadata to pybids layout faq #2546

Merged
merged 1 commit into from
Sep 16, 2021
Merged

DOC: Add --index-metadata to pybids layout faq #2546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,9 +307,9 @@ Depending on the amount of files and metadata within the BIDS dataset, this proc
As of the 20.2.0 release, *fMRIPrep* supports the ``--bids-database-dir <database_dir>`` option,
which can be used to pass in an already indexed BIDS layout.

The default *fMRIPrep* layout can be generated by running the following shell command (requires PyBIDS 0.12.1 or greater)::
The default *fMRIPrep* layout can be generated by running the following shell command (requires PyBIDS 0.13.2 or greater)::

pybids layout <bids_root> <database_dir> --no-validate
pybids layout <bids_root> <database_dir> --no-validate --index-metadata

where ``<bids_root>`` indicates the root path of the BIDS dataset, and ``<database_dir>``
is the path where the pre-indexed layout is created - which is then passed into *fMRIPrep*.
Expand All @@ -319,7 +319,7 @@ finer control can be achieved of what files are visible to fMRIPrep.

Note that any discrepancies between the pre-indexed database and
the BIDS dataset complicate the provenance of fMRIPrep derivatives.
If `--bids-database-dir` is used, the referenced directory should be
If ``--bids-database-dir`` is used, the referenced directory should be
preserved for the sake of reporting and reproducibility.

Error in slice timing correction: *insufficient length of BOLD data after discarding nonsteady-states*
Expand Down