Skip to content

Commit

Permalink
Update famafrench.utils.get_statsTable.html
Browse files Browse the repository at this point in the history
  • Loading branch information
christianjauregui committed Apr 26, 2020
1 parent f5ff407 commit 3afc9b2
Showing 1 changed file with 3 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
<h1>famafrench.utils.get_statsTable<a class="headerlink" href="#famafrench-utils-get-statstable" title="Permalink to this headline"></a></h1>
<dl class="function">
<dt id="famafrench.utils.get_statsTable">
<code class="sig-prename descclassname">famafrench.utils.</code><code class="sig-name descname">get_statsTable</code><span class="sig-paren">(</span><em class="sig-param">dType, dFreq, df, dates_as_index=True, ptiles=[0.01, 0.1, 0.25, 0.5, 0.75, 0.9, 0.99]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/famafrench/utils.html#get_statsTable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#famafrench.utils.get_statsTable" title="Permalink to this definition"></a></dt>
<code class="sig-prename descclassname">famafrench.utils.</code><code class="sig-name descname">get_statsTable</code><span class="sig-paren">(</span><em class="sig-param">dType</em>, <em class="sig-param">dFreq</em>, <em class="sig-param">df</em>, <em class="sig-param">dates_as_index=True</em>, <em class="sig-param">ptiles=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/famafrench/utils.html#get_statsTable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#famafrench.utils.get_statsTable" title="Permalink to this definition"></a></dt>
<dd><p>Construct detailed tables with summary statistics.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
Expand Down Expand Up @@ -208,7 +208,8 @@ <h1>famafrench.utils.get_statsTable<a class="headerlink" href="#famafrench-utils
or <cite>average</cite> anomaly portfolio characteristics for a given portfolio sorting strategy.</p></li>
<li><p><strong>dates_as_index</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Flag determining whether <code class="docutils literal notranslate"><span class="pre">df</span></code> has a <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DatetimeIndex.html#pandas.DatetimeIndex" title="(in pandas v1.0.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pandas.DatetimeIndex</span></code></a> index (<code class="docutils literal notranslate"><span class="pre">dates_as_index</span> <span class="pre">=</span> <span class="pre">True</span></code>).
Otherwise, <code class="docutils literal notranslate"><span class="pre">dates_as_index</span> <span class="pre">=</span> <span class="pre">False</span></code>.</p></li>
<li><p><strong>ptiles</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.8)"><em>list</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)"><em>float</em></a><em>, </em><em>default</em><em> [</em><em>0.01</em><em>, </em><em>0.1</em><em>, </em><em>0.25</em><em>, </em><em>0.5</em><em>, </em><em>0.75</em><em>, </em><em>0.9</em><em>, </em><em>0.99</em><em>]</em>) – List of percentiles (in decimal format) included as part of output results.</p></li>
<li><p><strong>ptiles</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.8)"><em>list</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.8)"><em>float</em></a><em>, </em><em>default None</em>) – List of percentiles (in decimal format) included as part of output results.
If <code class="docutils literal notranslate"><span class="pre">None</span></code>, then <code class="docutils literal notranslate"><span class="pre">ptiles</span> <span class="pre">=</span> <span class="pre">[0.01,</span> <span class="pre">0.1,</span> <span class="pre">0.25,</span> <span class="pre">0.5,</span> <span class="pre">0.75,</span> <span class="pre">0.9,</span> <span class="pre">0.99]</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down

0 comments on commit 3afc9b2

Please sign in to comment.