|
3 | 3 | [](https://travis-ci.com/codonlibrary/codonPython) |
4 | 4 | [](https://codecov.io/gh/codonlibrary/codonPython) |
5 | 5 |
|
6 | | -`codonPython` will reduce the entry barrier for analysis and provide software development experience for those at a higher level of technical ability. |
7 | | - |
8 | 6 | ## What is `codon`? |
9 | 7 |
|
10 | | -`Codon` is a project working towards creating a code repository to increase code sharing, consistancy and collaboration. The repository contains Python, R and SQL code for ease of use in workflows on platforms such as data bricks. Further information can be found [here](https://confluence.digital.nhs.uk/display/CON/Codon+-+Code+sharing), via our internal confluence page. |
| 8 | +The `codon` 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 data bricks. Further information for NHS Digital staff can be found [here](https://confluence.digital.nhs.uk/display/CON/Codon+-+Code+sharing), via our internal confluence page. `codonPython` aims to reduce the barrier for entry for analysis and provide software development experience for those at a higher level of technical ability. |
11 | 9 |
|
12 | 10 | ### Why `codon`? |
13 | 11 |
|
14 | | -**Transparency**: To aline with government data principles and build public trust. |
| 12 | +In biological terms, a `codon` 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. |
| 13 | + |
| 14 | +By sharing code, the project aims to: |
| 15 | + |
| 16 | +**Increase Transparency**: To aline with government data principles and build public trust. |
15 | 17 |
|
16 | 18 | **Improve Code**: To innovate and improve the code we use and provide. |
17 | 19 |
|
18 | | -**Usability**: Increase the accessibility and uniformity of code throughout the organisation. |
| 20 | +**Improve usability**: By increasing the accessibility and uniformity of code, it becomes easier for data users to find and use relevant code. |
19 | 21 |
|
20 | | -**Cost Effective**: Reusable 'generalised' code will increase efficient in creating higher level processes. |
| 22 | +**Be more cost effective**: Reusable 'generalised' code will increase efficiency in creating higher level processes. |
21 | 23 |
|
22 | 24 |
|
23 | | -## Instillation |
| 25 | +## Installation |
24 | 26 | The package can be directly installed by typing in your terminal: |
25 | 27 | ```r |
26 | 28 | python -m pip install --user git+https://github.com/codonlibrary/codonPython.git |
27 | 29 | ``` |
28 | | -For further guidance to clone a local repository to your machine from the remote repository using [GitBash/Command Line.](https://github.com/codonlibrary/codonPython/wiki/Installing-codonPython) |
| 30 | +For further guidance on cloning from the remote repository to a local repository on your machine see the information in our [Wiki.](https://github.com/codonlibrary/codonPython/wiki/Installing-codonPython) |
29 | 31 |
|
30 | 32 | ## Contributing to codonPython |
31 | | -All new contributions codon are welcome, please follow the Coding Conventions in the [guidance document.](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance. |
32 | | -Any improvements to documentaion, bug fixes or general code enhancments are also welcomed. If a bug is found on the master branch please use the GitHub guidance on raising and [issue.](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue) |
| 33 | +All new contributions to `codon` are welcome; please follow the Coding Conventions in the [guidance document](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance. |
| 34 | + |
| 35 | +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 [issue.](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue) |
33 | 36 |
|
34 | 37 | ## New to GitHub? |
35 | | -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. Beginners introductionary videos to GitHub can be found [here.](https://github.com/codonlibrary/codonPython/wiki/GitHub-for-Beginners) Quick links to begginer guidance can be found below; |
| 38 | +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. Beginners introductionary videos to GitHub can be found [here.](https://github.com/codonlibrary/codonPython/wiki/GitHub-for-Beginners) Quick links to begginer guidance can also be found below: |
36 | 39 |
|
37 | | -* [**Cloning a repositor to our local machine using GitBash**](https://github.com/codonlibrary/codonPython/wiki/Installing-codonPython) |
| 40 | +* [**Cloning a repository to your local machine using GitBash**](https://github.com/codonlibrary/codonPython/wiki/Installing-codonPython) |
38 | 41 | * [**Checking out a branch using GitBash**](https://github.com/codonlibrary/codonPython/wiki/Checkout-a-branch-using-GitBash) |
39 | 42 | * [**Removing a Commit from a repository using GitBash**](https://github.com/codonlibrary/codonPython/wiki/Remove-a-Commit-From-a-GitHub-Repository) |
40 | 43 |
|
41 | | -All other `Codon` "How-to Articles" can be found [here](https://github.com/codonlibrary/codonPython/wiki/How-To-Articles), suggestion on additional guidance or How to articles are welcome. |
| 44 | +All other `codon` "How-to Articles" can be found [here.](https://github.com/codonlibrary/codonPython/wiki/How-To-Articles) |
| 45 | + |
| 46 | +Suggestions regarding additional guidance or How-to articles are welcome. |
42 | 47 |
|
43 | 48 |
|
0 commit comments