Merge pull request #181 from PennLINC/docs/add_eg_list_sub_file

[DOCS] Add examples of --list_sub_file/--list-sub-file
PennLINC · Oct 18, 2024 · 5040907 · 5040907
2 parents dc3ad14 + 00ca7a2
commit 5040907
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/source/babs-init.rst b/docs/source/babs-init.rst
@@ -20,6 +20,11 @@ Command-Line Arguments
       :ref:`how-to-define-name-of-input-dataset` below for general guidelines
       and specific restrictions.
 
+   --list_sub_file, --list-sub-file : @after
+      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>`_.
+
    --keep_if_failed, --keep-if-failed : @after
       These words below somehow refuse to appear in the built docs...
       Please refer to below section

diff --git a/docs/source/preparation_config_yaml_file.rst b/docs/source/preparation_config_yaml_file.rst
@@ -147,6 +147,7 @@ Basics - Manual of writing section ``singularity_run``
 
             * See below :ref:`advanced_manual_singularity_run` --> bullet point regarding
               ``--bids-filter-file`` for explanations.
+            * See :ref:`babs-init` for examples of ``--list_sub_file``/``--list-sub-file`` to filter subjects and sessions.
 
     * :octicon:`alert-fill` :bdg-warning:`warning` Exception for positional arguments: if you have more than one input datasets,
       you must use ``$INPUT_PATH`` to specify which dataset to use for the positional argument input BIDS dataset.