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 Mar 8, 2024
1 parent 73c88c8 commit 1718bdd
Show file tree
Hide file tree
Showing 13 changed files with 12 additions and 12 deletions.
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 @@ -400,14 +400,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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 @@ -424,13 +424,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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 @@ -474,7 +474,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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 @@ -484,7 +484,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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 @@ -498,7 +498,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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 @@ -525,7 +525,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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 @@ -551,14 +551,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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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 v3.0.0.dev0+440.g737d390381)"><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 v3.0.0.dev0+491.g72874873e3)"><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.utils.spaces.html
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,7 @@

<dl class="py attribute">
<dt class="sig sig-object py" id="niworkflows.utils.spaces.SpatialReferences.standard_spaces">
<span class="sig-name descname"><span class="pre">standard_spaces</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('Fischer344',</span> <span class="pre">'MNI152Lin',</span> <span class="pre">'MNI152NLin2009aAsym',</span> <span class="pre">'MNI152NLin2009aSym',</span> <span class="pre">'MNI152NLin2009bAsym',</span> <span class="pre">'MNI152NLin2009bSym',</span> <span class="pre">'MNI152NLin2009cAsym',</span> <span class="pre">'MNI152NLin2009cSym',</span> <span class="pre">'MNI152NLin6Asym',</span> <span class="pre">'MNI152NLin6Sym',</span> <span class="pre">'MNI305',</span> <span class="pre">'MNIColin27',</span> <span class="pre">'MNIInfant',</span> <span class="pre">'MNIPediatricAsym',</span> <span class="pre">'MouseIn',</span> <span class="pre">'NKI',</span> <span class="pre">'NMT31Sym',</span> <span class="pre">'OASIS30ANTs',</span> <span class="pre">'PNC',</span> <span class="pre">'RESILIENT',</span> <span class="pre">'UNCInfant',</span> <span class="pre">'VALiDATe29',</span> <span class="pre">'WHS',</span> <span class="pre">'fsLR',</span> <span class="pre">'fsaverage',</span> <span class="pre">'onavg')</span></em><a class="headerlink" href="#niworkflows.utils.spaces.SpatialReferences.standard_spaces" title="Link to this definition">#</a></dt>
<span class="sig-name descname"><span class="pre">standard_spaces</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('Fischer344',</span> <span class="pre">'MNI152Lin',</span> <span class="pre">'MNI152NLin2009aAsym',</span> <span class="pre">'MNI152NLin2009aSym',</span> <span class="pre">'MNI152NLin2009bAsym',</span> <span class="pre">'MNI152NLin2009bSym',</span> <span class="pre">'MNI152NLin2009cAsym',</span> <span class="pre">'MNI152NLin2009cSym',</span> <span class="pre">'MNI152NLin6Asym',</span> <span class="pre">'MNI152NLin6Sym',</span> <span class="pre">'MNI305',</span> <span class="pre">'MNIColin27',</span> <span class="pre">'MNIInfant',</span> <span class="pre">'MNIPediatricAsym',</span> <span class="pre">'MouseIn',</span> <span class="pre">'NKI',</span> <span class="pre">'NMT31Sym',</span> <span class="pre">'OASIS30ANTs',</span> <span class="pre">'PNC',</span> <span class="pre">'RESILIENT',</span> <span class="pre">'UNCInfant',</span> <span class="pre">'VALiDATe29',</span> <span class="pre">'WHS',</span> <span class="pre">'dhcpAsym',</span> <span class="pre">'dhcpSym',</span> <span class="pre">'dhcpVol',</span> <span class="pre">'fsLR',</span> <span class="pre">'fsaverage',</span> <span class="pre">'onavg')</span></em><a class="headerlink" href="#niworkflows.utils.spaces.SpatialReferences.standard_spaces" title="Link to this definition">#</a></dt>
<dd><p>List of supported standard reference spaces.</p>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion master/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 1718bdd

Please sign in to comment.