Skip to content

Commit f1c1388

Browse files
traviscibottraviscibot
committed
Deploy codonlibrary/codonPython to github.com/codonlibrary/codonPython.git:gh-pages
1 parent b124627 commit f1c1388

4 files changed

Lines changed: 23 additions & 17 deletions

File tree

‎_static/basic.css‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,10 @@ div.code-block-caption + div > div.highlight > pre {
672672
margin-top: 0;
673673
}
674674

675+
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
676+
user-select: none;
677+
}
678+
675679
div.code-block-caption span.caption-number {
676680
padding: 0.1em 0.3em;
677681
font-style: italic;

‎_static/documentation_options.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ var DOCUMENTATION_OPTIONS = {
33
VERSION: '0.0.21',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
6+
BUILDER: 'html',
67
FILE_SUFFIX: '.html',
78
HAS_SOURCE: true,
89
SOURCELINK_SUFFIX: '.txt',

‎_static/searchtools.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ var Search = {
245245
if (results.length) {
246246
var item = results.pop();
247247
var listItem = $('<li style="display:none"></li>');
248-
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
248+
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
249249
// dirhtml builder
250250
var dirname = item[0] + '/';
251251
if (dirname.match(/\/index\/$/)) {
@@ -424,15 +424,15 @@ var Search = {
424424
for (j = 0; j < _files.length; j++) {
425425
file = _files[j];
426426
if (!(file in scoreMap))
427-
scoreMap[file] = {}
427+
scoreMap[file] = {};
428428
scoreMap[file][word] = o.score;
429429
}
430430
});
431431

432432
// create the mapping
433433
for (j = 0; j < files.length; j++) {
434434
file = files[j];
435-
if (file in fileMap)
435+
if (file in fileMap && fileMap[file].indexOf(word) === -1)
436436
fileMap[file].push(word);
437437
else
438438
fileMap[file] = [word];

‎codonPython.html‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
192192
</dd>
193193
</dl>
194194
<p class="rubric">Examples</p>
195-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">age_band_10_years</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
195+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">age_band_10_years</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
196196
<span class="go">&#39;0-9&#39;</span>
197197
<span class="gp">&gt;&gt;&gt; </span><span class="n">age_band_10_years</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
198198
<span class="go">&#39;Age not known&#39;</span>
@@ -220,7 +220,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
220220
</dd>
221221
</dl>
222222
<p class="rubric">Examples</p>
223-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">age_band_5_years</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
223+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">age_band_5_years</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
224224
<span class="go">&#39;0-4&#39;</span>
225225
<span class="gp">&gt;&gt;&gt; </span><span class="n">age_band_5_years</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
226226
<span class="go">&#39;Age not known&#39;</span>
@@ -255,7 +255,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
255255
</dd>
256256
</dl>
257257
<p class="rubric">Examples</p>
258-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_consistent_measures</span><span class="p">(</span>
258+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_consistent_measures</span><span class="p">(</span>
259259
<span class="gp">... </span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span>
260260
<span class="gp">... </span> <span class="s2">&quot;Geog&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s2">&quot;National&quot;</span> <span class="p">,</span><span class="s2">&quot;National&quot;</span><span class="p">,</span> <span class="s2">&quot;Region&quot;</span><span class="p">,</span> <span class="s2">&quot;Region&quot;</span><span class="p">,</span> <span class="s2">&quot;Local&quot;</span><span class="p">,</span> <span class="s2">&quot;Local&quot;</span><span class="p">,],</span>
261261
<span class="gp">... </span> <span class="s2">&quot;measure&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s2">&quot;m1&quot;</span><span class="p">,</span> <span class="s2">&quot;m2&quot;</span><span class="p">,</span> <span class="s2">&quot;m1&quot;</span><span class="p">,</span> <span class="s2">&quot;m2&quot;</span><span class="p">,</span> <span class="s2">&quot;m1&quot;</span><span class="p">,</span> <span class="s2">&quot;m2&quot;</span><span class="p">,],</span>
@@ -304,7 +304,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
304304
</dd>
305305
</dl>
306306
<p class="rubric">Examples</p>
307-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_consistent_submissions</span><span class="p">(</span>
307+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_consistent_submissions</span><span class="p">(</span>
308308
<span class="gp">... </span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span>
309309
<span class="gp">... </span> <span class="s2">&quot;Geog&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s2">&quot;N&quot;</span> <span class="p">,</span><span class="s2">&quot;N&quot;</span><span class="p">,</span> <span class="s2">&quot;Region&quot;</span><span class="p">,</span> <span class="s2">&quot;Region&quot;</span><span class="p">,</span> <span class="s2">&quot;Local&quot;</span><span class="p">,</span> <span class="s2">&quot;Local&quot;</span><span class="p">,],</span>
310310
<span class="gp">... </span> <span class="s2">&quot;measure&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s2">&quot;m1&quot;</span><span class="p">,</span> <span class="s2">&quot;m2&quot;</span><span class="p">,</span> <span class="s2">&quot;m1&quot;</span><span class="p">,</span> <span class="s2">&quot;m2&quot;</span><span class="p">,</span> <span class="s2">&quot;m1&quot;</span><span class="p">,</span> <span class="s2">&quot;m2&quot;</span><span class="p">,],</span>
@@ -358,7 +358,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
358358
</dd>
359359
</dl>
360360
<p class="rubric">Examples</p>
361-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_nat_val</span><span class="p">(</span>
361+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_nat_val</span><span class="p">(</span>
362362
<span class="gp">... </span> <span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span>
363363
<span class="gp">... </span> <span class="s2">&quot;Breakdown&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s1">&#39;National&#39;</span><span class="p">,</span> <span class="s1">&#39;CCG&#39;</span><span class="p">,</span> <span class="s1">&#39;CCG&#39;</span><span class="p">,</span> <span class="s1">&#39;Provider&#39;</span><span class="p">,</span> <span class="s1">&#39;Provider&#39;</span><span class="p">,</span>
364364
<span class="gp">... </span><span class="s1">&#39;National&#39;</span> <span class="p">,</span><span class="s1">&#39;CCG&#39;</span><span class="p">,</span> <span class="s1">&#39;CCG&#39;</span><span class="p">,</span> <span class="s1">&#39;Provider&#39;</span><span class="p">,</span> <span class="s1">&#39;Provider&#39;</span><span class="p">,</span><span class="s1">&#39;National&#39;</span> <span class="p">,</span><span class="s1">&#39;CCG&#39;</span><span class="p">,</span> <span class="s1">&#39;CCG&#39;</span><span class="p">,</span>
@@ -401,7 +401,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
401401
<dt id="codonPython.check_null.check_null">
402402
<code class="sig-prename descclassname">codonPython.check_null.</code><code class="sig-name descname">check_null</code><span class="sig-paren">(</span><em class="sig-param">dataframe: pandas.core.frame.DataFrame</em>, <em class="sig-param">columns_to_be_checked: list</em><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#codonPython.check_null.check_null" title="Permalink to this definition"></a></dt>
403403
<dd><p>Checks a pandas dataframe for null values</p>
404-
<p>This function takes a pandas dataframe supplied as an argument and returns a integer value representing any null values found within the columns to check</p>
404+
<p>This function takes a pandas dataframe supplied as an argument and returns a integer value
405+
representing any null values found within the columns to check.</p>
405406
<dl class="field-list simple">
406407
<dt class="field-odd">Parameters</dt>
407408
<dd class="field-odd"><ul class="simple">
@@ -417,7 +418,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
417418
</dd>
418419
</dl>
419420
<p class="rubric">Examples</p>
420-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_null</span><span class="p">(</span><span class="n">dataframe</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span><span class="s1">&#39;col1&#39;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">],</span> <span class="s1">&#39;col2&#39;</span><span class="p">:</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">]}),</span><span class="n">columns_to_be_checked</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;col1&#39;</span><span class="p">,</span> <span class="s1">&#39;col2&#39;</span><span class="p">])</span>
421+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_null</span><span class="p">(</span><span class="n">dataframe</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span><span class="s1">&#39;col1&#39;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">],</span> <span class="s1">&#39;col2&#39;</span><span class="p">:</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">]}),</span><span class="n">columns_to_be_checked</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;col1&#39;</span><span class="p">,</span> <span class="s1">&#39;col2&#39;</span><span class="p">])</span>
421422
<span class="go">0</span>
422423
<span class="gp">&gt;&gt;&gt; </span><span class="n">check_null</span><span class="p">(</span><span class="n">dataframe</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span><span class="s1">&#39;col1&#39;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="n">numpy</span><span class="o">.</span><span class="n">nan</span><span class="p">],</span> <span class="s1">&#39;col2&#39;</span><span class="p">:</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">]}),</span><span class="n">columns_to_be_checked</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;col1&#39;</span><span class="p">])</span>
423424
<span class="go">1</span>
@@ -445,7 +446,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
445446
</dd>
446447
</dl>
447448
<p class="rubric">Examples</p>
448-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">validDate</span><span class="p">(</span><span class="s2">&quot;11/02/1996&quot;</span><span class="p">)</span>
449+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">validDate</span><span class="p">(</span><span class="s2">&quot;11/02/1996&quot;</span><span class="p">)</span>
449450
<span class="go">True</span>
450451
<span class="gp">&gt;&gt;&gt; </span><span class="n">validDate</span><span class="p">(</span><span class="s2">&quot;29/02/2016&quot;</span><span class="p">)</span>
451452
<span class="go">True</span>
@@ -542,11 +543,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
542543
</dd>
543544
</dl>
544545
<p class="rubric">Examples</p>
545-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">file_search</span><span class="p">(</span><span class="n">doctype</span> <span class="o">=</span> <span class="s1">&#39;md&#39;</span><span class="p">)</span>
546+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">file_search</span><span class="p">(</span><span class="n">doctype</span> <span class="o">=</span> <span class="s1">&#39;md&#39;</span><span class="p">)</span>
546547
<span class="go">[&#39;README.md&#39;, &#39;CONTRIBUTING.md&#39;]</span>
547548
</pre></div>
548549
</div>
549-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">file_search</span><span class="p">(</span><span class="n">doctype</span> <span class="o">=</span> <span class="s1">&#39;md&#39;</span><span class="p">,</span> <span class="n">like</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;READ&#39;</span><span class="p">])</span>
550+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">file_search</span><span class="p">(</span><span class="n">doctype</span> <span class="o">=</span> <span class="s1">&#39;md&#39;</span><span class="p">,</span> <span class="n">like</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;READ&#39;</span><span class="p">])</span>
550551
<span class="go">[&#39;README.md&#39;]</span>
551552
</pre></div>
552553
</div>
@@ -661,7 +662,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
661662
</dd>
662663
</dl>
663664
<p class="rubric">Examples</p>
664-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">nhsNumberGenerator</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">random_state</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
665+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">nhsNumberGenerator</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">random_state</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
665666
<span class="go">[8429141456, 2625792787]</span>
666667
</pre></div>
667668
</div>
@@ -684,7 +685,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
684685
</dd>
685686
</dl>
686687
<p class="rubric">Examples</p>
687-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">nhsNumberValidator</span><span class="p">(</span><span class="mi">8429141456</span><span class="p">)</span>
688+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">nhsNumberValidator</span><span class="p">(</span><span class="mi">8429141456</span><span class="p">)</span>
688689
<span class="go">True</span>
689690
<span class="gp">&gt;&gt;&gt; </span><span class="n">nhsNumberValidator</span><span class="p">(</span><span class="mi">8429141457</span><span class="p">)</span>
690691
<span class="go">False</span>
@@ -719,7 +720,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
719720
</dd>
720721
</dl>
721722
<p class="rubric">Examples</p>
722-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">suppress_value</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
723+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">suppress_value</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
723724
<span class="go">&#39;*&#39;</span>
724725
<span class="gp">&gt;&gt;&gt; </span><span class="n">suppress_value</span><span class="p">(</span><span class="mi">24</span><span class="p">)</span>
725726
<span class="go">&#39;25&#39;</span>
@@ -818,7 +819,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
818819
</dd>
819820
</dl>
820821
<p class="rubric">Examples</p>
821-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_tolerance</span><span class="p">(</span>
822+
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">check_tolerance</span><span class="p">(</span>
822823
<span class="gp">... </span> <span class="n">t</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">1001</span><span class="p">,</span><span class="mi">1002</span><span class="p">,</span><span class="mi">1003</span><span class="p">,</span><span class="mi">1004</span><span class="p">,</span><span class="mi">1005</span><span class="p">,</span><span class="mi">1006</span><span class="p">]),</span>
823824
<span class="gp">... </span> <span class="n">y</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">([</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mf">4.5</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mf">5.1</span><span class="p">]),</span>
824825
<span class="gp">... </span> <span class="n">to_exclude</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>

0 commit comments

Comments
 (0)