Skip to content

Commit 3e1ced1

Browse files
authored
Merge pull request #183 from PennLINC/docs/add_eg_list_sub_file
[DOCS] Add examples of --list_sub_file/--list-sub-file - Fixed rendering issues
2 parents 5040907 + c418870 commit 3e1ced1

File tree

2 files changed

+4
-7
lines changed

2 files changed

+4
-7
lines changed

docs/source/babs-init.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ Command-Line Arguments
2020
:ref:`how-to-define-name-of-input-dataset` below for general guidelines
2121
and specific restrictions.
2222

23-
--list_sub_file, --list-sub-file : @after
24-
Examples:
25-
`Single-session example <https://github.com/PennLINC/babs/blob/ba32e8fd2d6473466d3c33a1b17dfffc4438d541/notebooks/initial_sub_list_single-ses.csv>`_,
26-
`Multi-session example <https://github.com/PennLINC/babs/blob/ba32e8fd2d6473466d3c33a1b17dfffc4438d541/notebooks/initial_sub_list_multi-ses.csv>`_.
27-
2823
--keep_if_failed, --keep-if-failed : @after
2924
These words below somehow refuse to appear in the built docs...
3025
Please refer to below section
@@ -86,7 +81,9 @@ How is the list of subjects (and sessions) determined?
8681
A list of subjects (and sessions) will be determined when running ``babs-init``,
8782
and will be saved in a CSV file called named ``sub_final_inclu.csv`` (for single-session dataset)
8883
or ``sub_ses_final_inclu.csv`` (for multiple-session dataset),
89-
located at ``/path/to/my_BABS_project/analysis/code``
84+
located at ``/path/to/my_BABS_project/analysis/code``.
85+
86+
**To filter subjects and sessions**, use ``babs-init`` with ``--list-sub-file /path/to/subject/list/csv/file``. Examples: `Single-session example <https://github.com/PennLINC/babs/blob/ba32e8fd2d6473466d3c33a1b17dfffc4438d541/notebooks/initial_sub_list_single-ses.csv>`_, `Multi-session example <https://github.com/PennLINC/babs/blob/ba32e8fd2d6473466d3c33a1b17dfffc4438d541/notebooks/initial_sub_list_multi-ses.csv>`_.
9087

9188
See :ref:`list_included_subjects` for how this list is determined.
9289

docs/source/preparation_config_yaml_file.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Basics - Manual of writing section ``singularity_run``
147147

148148
* See below :ref:`advanced_manual_singularity_run` --> bullet point regarding
149149
``--bids-filter-file`` for explanations.
150-
* See :ref:`babs-init` for examples of ``--list_sub_file``/``--list-sub-file`` to filter subjects and sessions.
150+
* See :doc:`babs-init` for examples of ``--list_sub_file``/``--list-sub-file`` to filter subjects and sessions.
151151

152152
* :octicon:`alert-fill` :bdg-warning:`warning` Exception for positional arguments: if you have more than one input datasets,
153153
you must use ``$INPUT_PATH`` to specify which dataset to use for the positional argument input BIDS dataset.

0 commit comments

Comments
 (0)