Skip to content

Commit

Permalink
Merge pull request #74 from FCP-INDI/dev0392
Browse files Browse the repository at this point in the history
fix link on pipeline config page
  • Loading branch information
jpellman committed May 19, 2016
2 parents 494f12d + 1ee450b commit b14f262
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/user/_sources/pipeline_config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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.
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.

Why a list?
'''''''''''
Expand Down
2 changes: 1 addition & 1 deletion docs/user/pipeline_config.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h2>Using a Text Editor<a class="headerlink" href="#using-a-text-editor" title="
<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>
<div class="highlight-python"><pre>key : value</pre>
</div>
<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>
<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>
<div class="section" id="why-a-list">
<h3>Why a list?<a class="headerlink" href="#why-a-list" title="Permalink to this headline"></a></h3>
<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>
Expand Down

0 comments on commit b14f262

Please sign in to comment.