|
|
<!DOCTYPE html> |
|
|
|
|
|
<html lang="en" data-content_root="./"> |
|
|
<head> |
|
|
<meta charset="utf-8" /> |
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
|
|
|
|
|
<title>Utils — AIM-CU 1.0.0 documentation</title> |
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" /> |
|
|
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=d35aba6c" /> |
|
|
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=0ca6144b" /> |
|
|
<script src="_static/documentation_options.js?v=8d563738"></script> |
|
|
<script src="_static/doctools.js?v=9bcbadda"></script> |
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
|
|
<link rel="index" title="Index" href="genindex.html" /> |
|
|
<link rel="search" title="Search" href="search.html" /> |
|
|
<link rel="prev" title="ARLTheoretical" href="ref_theoretical.html" /> |
|
|
|
|
|
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head><body> |
|
|
|
|
|
|
|
|
<div class="document"> |
|
|
<div class="documentwrapper"> |
|
|
<div class="bodywrapper"> |
|
|
|
|
|
|
|
|
<div class="body" role="main"> |
|
|
|
|
|
<section id="module-package.utils"> |
|
|
<span id="utils"></span><h1>Utils<a class="headerlink" href="#module-package.utils" title="Link to this heading">¶</a></h1> |
|
|
<p>Utilities to handle different operations</p> |
|
|
<dl class="py function"> |
|
|
<dt class="sig sig-object py" id="package.utils.get_greattable_as_html"> |
|
|
<span class="sig-prename descclassname"><span class="pre">package.utils.</span></span><span class="sig-name descname"><span class="pre">get_greattable_as_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">GT</span></span></span><a class="headerlink" href="#package.utils.get_greattable_as_html" title="Link to this definition">¶</a></dt> |
|
|
<dd><p>Get the great_table as HTML from Pandas dataframe.</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt> |
|
|
<dd class="field-odd"><p><strong>df</strong> (<em>pd.DataFrame</em>) – Dataframe to rendera as a table.</p> |
|
|
</dd> |
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt> |
|
|
<dd class="field-even"><p>Table in HTML format.</p> |
|
|
</dd> |
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt> |
|
|
<dd class="field-odd"><p>gt.GT</p> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py function"> |
|
|
<dt class="sig sig-object py" id="package.utils.populate_summary_table_ARL0_k"> |
|
|
<span class="sig-prename descclassname"><span class="pre">package.utils.</span></span><span class="sig-name descname"><span class="pre">populate_summary_table_ARL0_k</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">summary_table_df_ARL0_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">h</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">GT</span></span></span><a class="headerlink" href="#package.utils.populate_summary_table_ARL0_k" title="Link to this definition">¶</a></dt> |
|
|
<dd><p>Populate ARLTheoretical.summary_table_df_ARL0_k.</p> |
|
|
<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>summary_table_df_ARL0_k</strong> (<em>pd.DataFrame</em>) – Dataframe of ARL0 and its respective values of k.</p></li> |
|
|
<li><p><strong>h</strong> (<em>float</em>) – Normalized threshold.</p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt> |
|
|
<dd class="field-even"><p>Table of ARL0 and k in HTML format.</p> |
|
|
</dd> |
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt> |
|
|
<dd class="field-odd"><p>gt.GT</p> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py function"> |
|
|
<dt class="sig sig-object py" id="package.utils.populate_summary_table_ARL1_k"> |
|
|
<span class="sig-prename descclassname"><span class="pre">package.utils.</span></span><span class="sig-name descname"><span class="pre">populate_summary_table_ARL1_k</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">summary_table_df_ARL1_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dict_ARL0_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">OrderedDict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">h</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">GT</span></span></span><a class="headerlink" href="#package.utils.populate_summary_table_ARL1_k" title="Link to this definition">¶</a></dt> |
|
|
<dd><p>Populate Multiindex table specific for ARLTheoretical.summary_table_df_ARL1_k</p> |
|
|
<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>summary_table_df_ARL1_k</strong> (<em>pd.DataFrame</em>) – Dataframe with ARL1 and k values.</p></li> |
|
|
<li><p><strong>dict_ARL0_k</strong> (<em>OrderedDict</em>) – Data Dictionary with the mapping between ARL0 and k.</p></li> |
|
|
<li><p><strong>h</strong> (<em>float</em>) – Normalized threshold.</p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt> |
|
|
<dd class="field-even"><p>Table for ARL1 and k in HTML format.</p> |
|
|
</dd> |
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt> |
|
|
<dd class="field-odd"><p>gt.GT</p> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
</section> |
|
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main"> |
|
|
<div class="sphinxsidebarwrapper"> |
|
|
<h1 class="logo"><a href="index.html">AIM-CU</a></h1> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p> |
|
|
<iframe src="https://ghbtns.com/github-btn.html?user=DIDSR&repo=AIM-CU&type=watch&count=true&size=large&v=2" |
|
|
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe> |
|
|
</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<search id="searchbox" style="display: none" role="search"> |
|
|
<div class="searchformwrapper"> |
|
|
<form class="search" action="search.html" method="get"> |
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/> |
|
|
<input type="submit" value="Go" /> |
|
|
</form> |
|
|
</div> |
|
|
</search> |
|
|
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3> |
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
|
|
<ul class="current"> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_method.html">Methods</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_cusum.html">CUSUM</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="ref_theoretical.html">ARLTheoretical</a></li> |
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Utils</a><ul> |
|
|
<li class="toctree-l2"><a class="reference internal" href="#package.utils.get_greattable_as_html"><code class="docutils literal notranslate"><span class="pre">get_greattable_as_html()</span></code></a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="#package.utils.populate_summary_table_ARL0_k"><code class="docutils literal notranslate"><span class="pre">populate_summary_table_ARL0_k()</span></code></a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="#package.utils.populate_summary_table_ARL1_k"><code class="docutils literal notranslate"><span class="pre">populate_summary_table_ARL1_k()</span></code></a></li> |
|
|
</ul> |
|
|
</li> |
|
|
</ul> |
|
|
|
|
|
<div class="relations"> |
|
|
<h3>Related Topics</h3> |
|
|
<ul> |
|
|
<li><a href="index.html">Documentation overview</a><ul> |
|
|
<li>Previous: <a href="ref_theoretical.html" title="previous chapter">ARLTheoretical</a></li> |
|
|
</ul></li> |
|
|
</ul> |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
</div> |
|
|
<div class="clearer"></div> |
|
|
</div> |
|
|
<div class="footer"> |
|
|
|
|
|
|
|
|
|
|
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a> |
|
|
& <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a> |
|
|
|
|
|
| |
|
|
<a href="_sources/ref_utils.rst.txt" |
|
|
rel="nofollow">Page source</a> |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body> |
|
|
</html> |
