Commit b124627

Welcome to the Documentation!

modules

<link rel="search" title="Search" href="search.html" />

<link rel="prev" title="codonPython" href="modules.html" />

<p class="caption"><span class="caption-text">Contents:</span></p>

<ul class="current">

<li class="toctree-l1 current"><a class="reference internal" href="modules.html">codonPython</a><ul class="current">

<li class="toctree-l2 current"><a class="current reference internal" href="#">codonPython package</a><ul>

<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.age_bands">codonPython.age_bands module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_consistent_measures">codonPython.check_consistent_measures module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_consistent_submissions">codonPython.check_consistent_submissions module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_nat_val">codonPython.check_nat_val module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.check_null">codonPython.check_null module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.dateValidator">codonPython.dateValidator module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.file_utils">codonPython.file_utils module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.nhsd_colours">codonPython.nhsd_colours module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.nhsNumber">codonPython.nhsNumber module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.suppression">codonPython.suppression module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.tableFromSql">codonPython.tableFromSql module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython.tolerance">codonPython.tolerance module</a></li>

<li class="toctree-l3"><a class="reference internal" href="#module-codonPython">Module contents</a></li>

<li><a href="modules.html">codonPython</a> &raquo;</li>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="modules.html" class="btn btn-neutral float-left" title="codonPython" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

&copy; Copyright under BSD-3 license

<p class="caption"><span class="caption-text">Contents:</span></p>

<li class="toctree-l1"><a class="reference internal" href="modules.html">codonPython</a></li>

&copy; Copyright under BSD-3 license

<title>Welcome to the Documentation! &mdash; codon 0.0.21 documentation</title>

<link rel="search" title="Search" href="search.html" />

<link rel="next" title="codonPython" href="modules.html" />

<p class="caption"><span class="caption-text">Contents:</span></p>

<li class="toctree-l1"><a class="reference internal" href="modules.html">codonPython</a></li>

<li>Welcome to the Documentation!</li>

<div class="section" id="welcome-to-the-documentation">

<h1>Welcome to the Documentation!<a class="headerlink" href="#welcome-to-the-documentation" title="Permalink to this headline">¶</a></h1>

<div class="section" id="codonpython">

<h1>codonPython<a class="headerlink" href="#codonpython" title="Permalink to this headline">¶</a></h1>

<a class="reference external image-reference" href="https://travis-ci.com/codonlibrary/codonPython"><img alt="Build Status" src="https://travis-ci.com/codonlibrary/codonPython.svg?branch=master" /></a>

<a class="reference external image-reference" href="https://codecov.io/gh/codonlibrary/codonPython"><img alt="codecov" src="https://codecov.io/gh/codonlibrary/codonPython/branch/master/graph/badge.svg" /></a>

<div class="section" id="what-is-codon">

<h2>What is <code class="docutils literal notranslate"><span class="pre">codon</span></code>?<a class="headerlink" href="#what-is-codon" title="Permalink to this headline">¶</a></h2>

<p>The <code class="docutils literal notranslate"><span class="pre">codon</span></code> project was created to increase code sharing, consistancy of code and coding standards and encourage collaboration. The repository contains Python, R and SQL code for ease of use in workflows on platforms used within NHS Digital such as Databricks. Package documentation is available on the <a class="reference external" href="https://codonlibrary.github.io/codonPython/">GitHub pages</a> however further information for NHS Digital staff can be found <a class="reference external" href="https://confluence.digital.nhs.uk/display/CON/Codon+-+Code+sharing">here</a>, via our internal confluence page. <code class="docutils literal notranslate"><span class="pre">codonPython</span></code> aims to reduce the barrier for entry for analysis and provide software development experience for those at a higher level of technical ability.</p>

<div class="section" id="why-codon">

<h3>Why <code class="docutils literal notranslate"><span class="pre">codon</span></code>?<a class="headerlink" href="#why-codon" title="Permalink to this headline">¶</a></h3>

<p>In biological terms, a <code class="docutils literal notranslate"><span class="pre">codon</span></code> is one of the building blocks that make up our DNA. By openly sharing our code we hope that others will be able to take those blocks of code to build their own processes using the data that NHS Digital hold.</p>

<p>By sharing code, the project aims to:</p>

<p><strong>Increase Transparency</strong>: To align with government data principles and build public trust.</p>

<p><strong>Improve Code</strong>: To innovate and improve the code we use and provide.</p>

<p><strong>Improve usability</strong>: By increasing the accessibility and uniformity of code, it becomes easier for data users to find and use relevant code.</p>

<p><strong>Be more cost effective</strong>: Reusable ‘generalised’ code will increase efficiency in creating higher level processes.</p>

<div class="section" id="installation">

<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>

<p>The package can be directly installed by typing in your terminal:</p>

<div class="highlight-r notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">user</span> <span class="n">git</span><span class="o">+</span><span class="n">https</span><span class="o">://</span><span class="n">github.com</span><span class="o">/</span><span class="n">codonlibrary</span><span class="o">/</span><span class="n">codonPython.git</span>

<p>For further guidance on cloning from the remote repository to a local repository on your machine see the information in our <a class="reference external" href="https://github.com/codonlibrary/codonPython/wiki/1.-Installing-codonPython">Wiki.</a></p>

<div class="section" id="contributing-to-codonpython">

<h2>Contributing to codonPython<a class="headerlink" href="#contributing-to-codonpython" title="Permalink to this headline">¶</a></h2>

<p>All new contributions to <code class="docutils literal notranslate"><span class="pre">codon</span></code> are welcome; please follow the Coding Conventions in the <a class="reference external" href="https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md">guidance document</a> for contribution guidance.</p>

<p>Any improvements to documentation, bug fixes or general code enhancements are also welcomed. If a bug is found on the master branch, please use the GitHub guidance on raising an <a class="reference external" href="https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue">issue.</a></p>

<div class="section" id="new-to-github">

<h2>New to GitHub?<a class="headerlink" href="#new-to-github" title="Permalink to this headline">¶</a></h2>

<p>GitHub is a hosting site that allows for development and version control of software using Git. It allows users to edit and develop parts of code independently before submitting back to the master code, whilst using version control to track changes. Introductory videos to GitHub for beginners can be found <a class="reference external" href="https://github.com/codonlibrary/codonPython/wiki/2a.-GitHub-for-Beginners">here.</a></p>

<p>Quick links to beginner guidance can also be found below:</p>

<ul class="simple">

<li><p><a class="reference external" href="https://github.com/codonlibrary/codonPython/wiki/1.-Installing-codonPython">**Cloning a repository to your local machine using GitBash**</a></p></li>

<li><p><a class="reference external" href="https://github.com/codonlibrary/codonPython/wiki/2b.-Checkout-a-branch-using-GitBash">**Checking out a branch using GitBash**</a></p></li>

<li><p><a class="reference external" href="https://github.com/codonlibrary/codonPython/wiki/3.-Removing-a-Commit-From-a-GitHub-Repository">**Removing a Commit from a repository using GitBash**</a></p></li>

<p>All other <code class="docutils literal notranslate"><span class="pre">codon</span></code> “How-to Articles” can be found <a class="reference external" href="https://github.com/codonlibrary/codonPython/wiki/2.-Git-Guidance">here.</a></p>

<p>Suggestions regarding additional guidance or How-to articles are welcome.</p>

<p class="caption"><span class="caption-text">Contents:</span></p>

<li class="toctree-l1"><a class="reference internal" href="modules.html">codonPython</a><ul>

<li class="toctree-l2"><a class="reference internal" href="codonPython.html">codonPython package</a></li>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="modules.html" class="btn btn-neutral float-right" title="codonPython" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>

</div>

&copy; Copyright under BSD-3 license

<link rel="search" title="Search" href="search.html" />

<link rel="next" title="codonPython package" href="codonPython.html" />

<link rel="prev" title="Welcome to the Documentation!" href="index.html" />

<p class="caption"><span class="caption-text">Contents:</span></p>

<ul class="current">

<li class="toctree-l1 current"><a class="current reference internal" href="#">codonPython</a><ul>

<li class="toctree-l2"><a class="reference internal" href="codonPython.html">codonPython package</a></li>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="codonPython.html" class="btn btn-neutral float-right" title="codonPython package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>

<a href="index.html" class="btn btn-neutral float-left" title="Welcome to the Documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

&copy; Copyright under BSD-3 license

<p class="caption"><span class="caption-text">Contents:</span></p>

<li class="toctree-l1"><a class="reference internal" href="modules.html">codonPython</a></li>

&copy; Copyright under BSD-3 license

<p class="caption"><span class="caption-text">Contents:</span></p>

<li class="toctree-l1"><a class="reference internal" href="modules.html">codonPython</a></li>

&copy; Copyright under BSD-3 license