Skip to content

Commit 1ee450b

Browse files
committed
fix link on pipeline config page
1 parent d74fd95 commit 1ee450b

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/user/_sources/pipeline_config.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Pipeline configuration files, like the data configuration and subject list files
2727

2828
key : value
2929

30-
An example of a pipeline configuration YAML file can be found `here <https://raw.githubusercontent.com/FCP-INDI/C-PAC/master/configs/pipeline_config.yml>`_. 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 </output_config>`,:doc:`Preprocessing Workflow Options </preprocwf_config>`, and :doc:`Derivatives Settings </deriv_config>` tables defined.
30+
An example of a pipeline configuration YAML file can be found `here <https://raw.githubusercontent.com/FCP-INDI/C-PAC/master/configs/pipeline_config.yml>`_. 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 </output_config>`, :doc:`Preprocessing Workflow Options </preprocwf_config>`, and :doc:`Derivatives Settings </deriv_config>` tables defined.
3131

3232
Why a list?
3333
'''''''''''

docs/user/pipeline_config.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h2>Using a Text Editor<a class="headerlink" href="#using-a-text-editor" title="
9090
<p>Pipeline configuration files, like the data configuration and subject list files discussed in the <a class="reference external" href="subject_list_config">subject list builder section</a>, 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:</p>
9191
<div class="highlight-python"><pre>key : value</pre>
9292
</div>
93-
<p>An example of a pipeline configuration YAML file can be found <a class="reference external" href="https://raw.githubusercontent.com/FCP-INDI/C-PAC/master/configs/pipeline_config.yml">here</a>. 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 <a class="reference internal" href="output_config.html"><em>Output Settings</em></a>,:doc:<cite>Preprocessing Workflow Options &lt;/preprocwf_config&gt;</cite>, and <a class="reference internal" href="deriv_config.html"><em>Derivatives Settings</em></a> tables defined.</p>
93+
<p>An example of a pipeline configuration YAML file can be found <a class="reference external" href="https://raw.githubusercontent.com/FCP-INDI/C-PAC/master/configs/pipeline_config.yml">here</a>. 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 <a class="reference internal" href="output_config.html"><em>Output Settings</em></a>, <a class="reference internal" href="preprocwf_config.html"><em>Preprocessing Workflow Options</em></a>, and <a class="reference internal" href="deriv_config.html"><em>Derivatives Settings</em></a> tables defined.</p>
9494
<div class="section" id="why-a-list">
9595
<h3>Why a list?<a class="headerlink" href="#why-a-list" title="Permalink to this headline"></a></h3>
9696
<p>You may notice as you learn about the settings for various outputs that many of the values for C-PAC&#8217;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 &#8216;True&#8217; and &#8216;False&#8217; respectively) allow you to toggle on multiple options at the same time, and branch a pipeline into two different analysis strategies. See the <a class="reference external" href="http://fcp-indi.github.io/docs/developer/workflows/cpac_pipeline.html">developer documentation</a> for more information about how lists are used in C-PAC.</p>

0 commit comments

Comments
 (0)