diff --git a/docs/user/_sources/pipeline_config.txt b/docs/user/_sources/pipeline_config.txt index e62dcee76..74d8afc33 100644 --- a/docs/user/_sources/pipeline_config.txt +++ b/docs/user/_sources/pipeline_config.txt @@ -27,7 +27,7 @@ Pipeline configuration files, like the data configuration and subject list files key : value -An example of a pipeline configuration YAML file can be found `here `_. Tables explaining the keys and their potential values can be found on the individual pages for each of the outputs C-PAC is capable of producing. All pipeline configuration files should have the keys in the :doc:`Output Settings `,:doc:`Preprocessing Workflow Options `, and :doc:`Derivatives Settings ` tables defined. +An example of a pipeline configuration YAML file can be found `here `_. Tables explaining the keys and their potential values can be found on the individual pages for each of the outputs C-PAC is capable of producing. All pipeline configuration files should have the keys in the :doc:`Output Settings `, :doc:`Preprocessing Workflow Options `, and :doc:`Derivatives Settings ` tables defined. Why a list? ''''''''''' diff --git a/docs/user/pipeline_config.html b/docs/user/pipeline_config.html index 348752bcc..d199777d7 100644 --- a/docs/user/pipeline_config.html +++ b/docs/user/pipeline_config.html @@ -90,7 +90,7 @@

Using a Text Editorsubject list builder section, are stored as YAML files. Similarly, each of the parameters used by C-PAC to assemble your pipeline can be specified as key-value pairs, so a pipeline configuration YAML would have multiple lines of the form:

key : value
-

An example of a pipeline configuration YAML file can be found here. Tables explaining the keys and their potential values can be found on the individual pages for each of the outputs C-PAC is capable of producing. All pipeline configuration files should have the keys in the Output Settings,:doc:Preprocessing Workflow Options </preprocwf_config>, and Derivatives Settings tables defined.

+

An example of a pipeline configuration YAML file can be found here. Tables explaining the keys and their potential values can be found on the individual pages for each of the outputs C-PAC is capable of producing. All pipeline configuration files should have the keys in the Output Settings, Preprocessing Workflow Options, and Derivatives Settings tables defined.

Why a list?ΒΆ

You may notice as you learn about the settings for various outputs that many of the values for C-PAC’s configurable settings are stored in lists (i.e., multiple values are separated by commas and surrounded by square brackets). Such lists containing 1s and 0s (for ‘True’ and ‘False’ respectively) allow you to toggle on multiple options at the same time, and branch a pipeline into two different analysis strategies. See the developer documentation for more information about how lists are used in C-PAC.