-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathindex.html
More file actions
261 lines (151 loc) · 11.2 KB
/
index.html
File metadata and controls
261 lines (151 loc) · 11.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to the Documentation! — codon 0.0.21 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="codonPython" href="modules.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> codon
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">codonPython</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">codon</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Welcome to the Documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<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>
<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>
<a class="reference external image-reference" href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.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, code consistency, coding standards, and encourage collaboration. Package documentation is available on the <a class="reference external" href="https://codonlibrary.github.io/codonPython/">GitHub pages</a>. <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>
</div>
<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>
</pre></div>
</div>
<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>
<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>
<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>
</ul>
<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>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<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>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>
</div>
<footer>
<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>
<hr/>
<div role="contentinfo">
<p>
© Copyright under BSD-3 license
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>