build based on 119d89b

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-01-25T15:36:39","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-01-25T15:52:07","documenter_version":"1.2.1"}}

dev/index.html

@@ -125,4 +125,4 @@
  39999 │  2021    109   1912.0      6.89      0.96      7.85
  40000 │  2021    109   1911.0      4.7       0.63      5.33
  40001 │  2021    110      0.0      9.13      0.68      9.81
-                                           39952 rows omitted</code></pre><h2 id="Package-Features"><a class="docs-heading-anchor" href="#Package-Features">Package Features</a><a id="Package-Features-1"></a><a class="docs-heading-anchor-permalink" href="#Package-Features" title="Permalink"></a></h2><ul><li>Downloads and creates a <code>DataFrame</code> object for a given country, type of table, and interval.</li><li>Provides the functionality to save output as CSVs.</li><li>Supports full country and table names.</li><li>Displays available countries and tables.</li></ul><h2 id="TODO"><a class="docs-heading-anchor" href="#TODO">TODO</a><a id="TODO-1"></a><a class="docs-heading-anchor-permalink" href="#TODO" title="Permalink"></a></h2><ul><li>Check all combinations and flag invalid ones.</li><li>Add unit tests</li></ul><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.get_countries-Tuple{}" href="#HMD.get_countries-Tuple{}"><code>HMD.get_countries</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>get_countries()</code></p><p>Returns a <code>Dictionary</code> of valid countries and territories (i.e &quot;Australia&quot;, &quot;Austria&quot;, etc.)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/f9e8b6bcb3dc6656186595a06b5e124bb3df97d0/src/HMD.jl#L132-L136">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.get_groups-Tuple{}" href="#HMD.get_groups-Tuple{}"><code>HMD.get_groups</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>get_groups()</code></p><p>Returns a <code>Vector</code> of valid groupings (i.e. &quot;1x1&quot;, &quot;1x5&quot;, etc.)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/f9e8b6bcb3dc6656186595a06b5e124bb3df97d0/src/HMD.jl#L227-L231">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.get_tables-Tuple{}" href="#HMD.get_tables-Tuple{}"><code>HMD.get_tables</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>get_tables()</code></p><p>Returns a <code>Dictionary</code> of valid tables (i.e. &quot;Births&quot;, &quot;Deaths&quot;, etc.).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/f9e8b6bcb3dc6656186595a06b5e124bb3df97d0/src/HMD.jl#L200-L204">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.read_HMD-NTuple{5, String}" href="#HMD.read_HMD-NTuple{5, String}"><code>HMD.read_HMD</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>read_HMD(country::String, tbl::String, grp::String, username::String, password::String; save=false, verbose=false)</code></p><p>Takes as input the country, table, interval and user credentials.</p><ul><li><code>country</code> the country OR country code – see <code>get_country()</code> for a full list</li><li><code>tbl</code> the chosen table OR table code – see <code>get_table()</code> for a full list</li><li><code>grp</code> one of &quot;1x1&quot;, &quot;1x5&quot;, &quot;1x10&quot; – depending on combination with <code>tbl</code></li><li><code>username</code> email address when registering</li><li><code>password</code> password when registering</li></ul><p>Optional:</p><ul><li><code>save</code> a Boolean keyword to save to a CSV</li><li><code>verbose</code> for progress logs</li></ul><p>Returns a <code>DataFrame</code> object if successful.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/f9e8b6bcb3dc6656186595a06b5e124bb3df97d0/src/HMD.jl#L10-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.read_HMD-Tuple{String}" href="#HMD.read_HMD-Tuple{String}"><code>HMD.read_HMD</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>read_HMD(file_name::String; save=false, verbose=false)</code></p><p>Takes as input the location of a .txt file downloaded from https://www.mortality.org/ and stored locally</p><p>Optional:</p><ul><li><code>save</code> a Boolean keyword to save to a CSV</li><li><code>verbose</code> for progress logs</li></ul><p>Returns a <code>DataFrame</code> object containing the data.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/f9e8b6bcb3dc6656186595a06b5e124bb3df97d0/src/HMD.jl#L94-L104">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 25 January 2024 15:36">Thursday 25 January 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                                           39952 rows omitted</code></pre><h2 id="Package-Features"><a class="docs-heading-anchor" href="#Package-Features">Package Features</a><a id="Package-Features-1"></a><a class="docs-heading-anchor-permalink" href="#Package-Features" title="Permalink"></a></h2><ul><li>Downloads and creates a <code>DataFrame</code> object for a given country, type of table, and interval.</li><li>Provides the functionality to save output as CSVs.</li><li>Supports full country and table names.</li><li>Displays available countries and tables.</li></ul><h2 id="TODO"><a class="docs-heading-anchor" href="#TODO">TODO</a><a id="TODO-1"></a><a class="docs-heading-anchor-permalink" href="#TODO" title="Permalink"></a></h2><ul><li>Check all combinations and flag invalid ones.</li><li>Add unit tests</li></ul><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.get_countries-Tuple{}" href="#HMD.get_countries-Tuple{}"><code>HMD.get_countries</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>get_countries()</code></p><p>Returns a <code>Dictionary</code> of valid countries and territories (i.e &quot;Australia&quot;, &quot;Austria&quot;, etc.)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/119d89ba07ad453bbc2ea6c3e28c6acd8773bf07/src/HMD.jl#L132-L136">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.get_groups-Tuple{}" href="#HMD.get_groups-Tuple{}"><code>HMD.get_groups</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>get_groups()</code></p><p>Returns a <code>Vector</code> of valid groupings (i.e. &quot;1x1&quot;, &quot;1x5&quot;, etc.)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/119d89ba07ad453bbc2ea6c3e28c6acd8773bf07/src/HMD.jl#L227-L231">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.get_tables-Tuple{}" href="#HMD.get_tables-Tuple{}"><code>HMD.get_tables</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>get_tables()</code></p><p>Returns a <code>Dictionary</code> of valid tables (i.e. &quot;Births&quot;, &quot;Deaths&quot;, etc.).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/119d89ba07ad453bbc2ea6c3e28c6acd8773bf07/src/HMD.jl#L200-L204">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.read_HMD-NTuple{5, String}" href="#HMD.read_HMD-NTuple{5, String}"><code>HMD.read_HMD</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>read_HMD(country::String, tbl::String, grp::String, username::String, password::String; save=false, verbose=false)</code></p><p>Takes as input the country, table, interval and user credentials.</p><ul><li><code>country</code> the country OR country code – see <code>get_country()</code> for a full list</li><li><code>tbl</code> the chosen table OR table code – see <code>get_table()</code> for a full list</li><li><code>grp</code> one of &quot;1x1&quot;, &quot;1x5&quot;, &quot;1x10&quot; – depending on combination with <code>tbl</code></li><li><code>username</code> email address when registering</li><li><code>password</code> password when registering</li></ul><p>Optional:</p><ul><li><code>save</code> a Boolean keyword to save to a CSV</li><li><code>verbose</code> for progress logs</li></ul><p>Returns a <code>DataFrame</code> object if successful.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/119d89ba07ad453bbc2ea6c3e28c6acd8773bf07/src/HMD.jl#L10-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="HMD.read_HMD-Tuple{String}" href="#HMD.read_HMD-Tuple{String}"><code>HMD.read_HMD</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>read_HMD(file_name::String; save=false, verbose=false)</code></p><p>Takes as input the location of a .txt file downloaded from https://www.mortality.org/ and stored locally</p><p>Optional:</p><ul><li><code>save</code> a Boolean keyword to save to a CSV</li><li><code>verbose</code> for progress logs</li></ul><p>Returns a <code>DataFrame</code> object containing the data.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/patrickm663/HMD.jl/blob/119d89ba07ad453bbc2ea6c3e28c6acd8773bf07/src/HMD.jl#L94-L104">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Thursday 25 January 2024 15:52">Thursday 25 January 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>