The National Reusable Code Library is intended to agree, centralise and enable to reuse of common methods within the Health and Care sector. This will encourage consistancy of analysis, 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 the NHS. Package documentation will be available shortly, but each function and module should have a docstring.
The National Reusable Code Library aims to reduce the barrier for entry for analysis and data engineering, meaning colleagues need to develop less new code, and instead giving them the opportunity to help improve and reuse existing code, also making the opportunity of more advanced software development experience for those at a higher level of technical ability.
Briefly, our colleagues write a lot of the same stuff, again and again. This by itself is wasteful, but it also leads to inconsistency, error and a lack of improvement, not to mention it's boring and doesn't stretch our colleagues and allow them to learn and build.
By making code reusable, and making it easy to reuse, this work aims to:
Increase Transparency: To align with government data principles and build public trust.
Improve Code: To innovate and improve the code we use and provide.
Improve usability: By increasing the accessibility and uniformity of code, it becomes easier for data users to find and use relevant code.
Be more cost effective: Reusable 'generalised' code will increase efficiency in creating higher level processes.
The package can be directly installed by typing in your terminal:
# TBCOther platform specific instructions to follow.
All new contributions to the National Reusable Code Library are welcome; please follow the Coding Conventions in the guidance document for contribution guidance.
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.
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 here.
Quick links to beginner guidance can also be found below:
- Cloning a repository to your local machine using GitBash
- Checking out a branch using GitBash
- Removing a Commit from a repository using GitBash
All other codon "How-to Articles" can be found here.
Suggestions regarding additional guidance or How-to articles are welcome.