Skip to content

Commit

Permalink
docs(master): Update docs of development line
Browse files Browse the repository at this point in the history
  • Loading branch information
nipreps-bot committed Nov 28, 2023
1 parent e44fcce commit 54cebac
Show file tree
Hide file tree
Showing 16 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion master/_modules/niworkflows/workflows/epi/refmap.html
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ <h1>Source code for niworkflows.workflows.epi.refmap</h1><div class="highlight">
<span class="sd"> n_dummy_scans : :obj:`list` of :obj:`int`</span>
<span class="sd"> Number of nonsteady states at the beginning of each run (only BOLD with</span>
<span class="sd"> ``auto_bold_nss=True``)</span>
<span class="sd"> validate_report : :obj:`str`</span>
<span class="sd"> validation_report : :obj:`str`</span>
<span class="sd"> HTML reportlet(s) indicating whether the input files had a valid affine</span>

<span class="sd"> See Also</span>
Expand Down
Binary file modified master/api/niworkflows-anat-ants-1.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-anat-ants-2.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-anat-ants-3.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-anat-coregistration-1.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-anat-freesurfer-1.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-anat-skullstrip-1.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-func-util-1.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-func-util-2.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-func-util-3.pdf
Binary file not shown.
Binary file modified master/api/niworkflows-workflows-epi-refmap-1.pdf
Binary file not shown.
20 changes: 10 additions & 10 deletions master/api/niworkflows.interfaces.confounds.html
Original file line number Diff line number Diff line change
Expand Up @@ -398,14 +398,14 @@
indicates that the first and second exponential terms should be added.
To retain the original terms, <code class="docutils literal notranslate"><span class="pre">1</span></code> <em>must</em> be included in the list.</p></li>
<li><p><strong>variables</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – List of variables for which exponential terms should be computed.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>variables_exp</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – A list of variables to include in the final data frame after adding
the specified exponential terms.</p></li>
<li><p><strong>data_exp</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables, including any
<li><p><strong>data_exp</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables, including any
specified exponential terms.</p></li>
</ul>
</p>
Expand All @@ -422,13 +422,13 @@
<dd class="field-odd"><ul class="simple">
<li><p><strong>expression</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – Formula expression: either a single variable or a variable group
paired with an operation (exponentiation or differentiation).</p></li>
<li><p><strong>parent_data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – The source data for the model expansion.</p></li>
<li><p><strong>parent_data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – The source data for the model expansion.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>variables</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – A list of variables in the provided formula expression.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – A tabulation of all terms in the provided formula expression.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – A tabulation of all terms in the provided formula expression.</p></li>
</ul>
</p>
</dd>
Expand Down Expand Up @@ -472,7 +472,7 @@
<p>Temporal derivatives and exponential terms are computed for all terms
in the grouping symbols that they adjoin.</p>
</li>
<li><p><strong>parent_data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – A tabulation of all values usable in the model formula. Each additive
<li><p><strong>parent_data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – A tabulation of all values usable in the model formula. Each additive
term in <cite>model_formula</cite> should correspond either to a variable in this
data frame or to instructions for operating on a variable (for
instance, computing temporal derivatives or exponential terms).</p></li>
Expand All @@ -482,7 +482,7 @@
<dd class="field-even"><p><ul class="simple">
<li><p><strong>variables</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – A list of variables included in the model parsed from the provided
formula.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – All values in the complete model.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – All values in the complete model.</p></li>
</ul>
</p>
</dd>
Expand All @@ -496,7 +496,7 @@
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – A tabulation of observations from which spike regressors should be
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – A tabulation of observations from which spike regressors should be
estimated.</p></li>
<li><p><strong>criteria</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></a> of (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, <code class="docutils literal notranslate"><span class="pre">'&gt;'</span></code> or <code class="docutils literal notranslate"><span class="pre">'&lt;'</span></code> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></a>)) – Criteria for generating a spike regressor. If, for a given frame, the
value of the variable corresponding to the key exceeds the threshold
Expand All @@ -523,7 +523,7 @@
<dd class="field-even"><p><strong>data</strong> – The input DataFrame with a column for each spike regressor.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a></p>
<dd class="field-odd"><p><a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a></p>
</dd>
</dl>
<p class="rubric">References</p>
Expand All @@ -549,14 +549,14 @@
To retain the original terms, <code class="docutils literal notranslate"><span class="pre">0</span></code> <em>must</em> be included in the list.</p></li>
<li><p><strong>variables</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – List of variables for which temporal derivative terms should be
computed.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables.</p></li>
<li><p><strong>data</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>variables_deriv</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a>) – A list of variables to include in the final data frame after adding
the specified derivative terms.</p></li>
<li><p><strong>data_deriv</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+621.gde9815c6c5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables, including any
<li><p><strong>data_deriv</strong> (<a class="reference external" href="https://pandas.pydata.org/pandas-docs/dev/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.0.dev0+750.g7012d6a607)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>) – Table of values of all observations of all variables, including any
specified derivative terms.</p></li>
</ul>
</p>
Expand Down
2 changes: 1 addition & 1 deletion master/api/niworkflows.viz.html
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@
<li><p><strong>sort_rows</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>) – Apply a clustering algorithm to reorganize the rows of the carpet.
<code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">False</span></code>, and <code class="docutils literal notranslate"><span class="pre">None</span></code> skip clustering sorting.
<code class="docutils literal notranslate"><span class="pre">&quot;linkage&quot;</span></code> uses linkage hierarchical clustering
<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.cluster.hierarchy.linkage.html#scipy.cluster.hierarchy.linkage" title="(in SciPy v1.11.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.cluster.hierarchy.linkage</span></code></a>.
<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.cluster.hierarchy.linkage.html#scipy.cluster.hierarchy.linkage" title="(in SciPy v1.11.4)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.cluster.hierarchy.linkage</span></code></a>.
Any other value that Python evaluates to <code class="docutils literal notranslate"><span class="pre">True</span></code> will use the
default clustering, which is <code class="xref py py-obj docutils literal notranslate"><span class="pre">sklearn.cluster.ward_tree</span></code>.</p></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion master/api/niworkflows.viz.plots.html
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@
<li><p><strong>sort_rows</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>) – Apply a clustering algorithm to reorganize the rows of the carpet.
<code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">False</span></code>, and <code class="docutils literal notranslate"><span class="pre">None</span></code> skip clustering sorting.
<code class="docutils literal notranslate"><span class="pre">&quot;linkage&quot;</span></code> uses linkage hierarchical clustering
<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.cluster.hierarchy.linkage.html#scipy.cluster.hierarchy.linkage" title="(in SciPy v1.11.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.cluster.hierarchy.linkage</span></code></a>.
<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.cluster.hierarchy.linkage.html#scipy.cluster.hierarchy.linkage" title="(in SciPy v1.11.4)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.cluster.hierarchy.linkage</span></code></a>.
Any other value that Python evaluates to <code class="docutils literal notranslate"><span class="pre">True</span></code> will use the
default clustering, which is <code class="xref py py-obj docutils literal notranslate"><span class="pre">sklearn.cluster.ward_tree</span></code>.</p></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion master/api/niworkflows.workflows.epi.refmap.html
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@
for averaging, per run.</p></li>
<li><p><strong>n_dummy_scans</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a>) – Number of nonsteady states at the beginning of each run (only BOLD with
<code class="docutils literal notranslate"><span class="pre">auto_bold_nss=True</span></code>)</p></li>
<li><p><strong>validate_report</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – HTML reportlet(s) indicating whether the input files had a valid affine</p></li>
<li><p><strong>validation_report</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – HTML reportlet(s) indicating whether the input files had a valid affine</p></li>
</ul>
</dd>
</dl>
Expand Down
2 changes: 1 addition & 1 deletion master/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 54cebac

Please sign in to comment.