nhspy-plotthedots v0.1.0 {alpha}

nhspy-plotthedots v0.1.0 {alpha}

NHS Python Community
Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Note: This is an alpha project, not for use in production until v1.0.0

We are working with the NHS-R community to develop a python implementation of 'NHSRplotthedots' SPC package to support NHSE/I 'Making Data Count' programme

Base Code by Tom Jemmett

• https://gist.github.com/tomjemmett/c167376e5b6464ec1c00975be2d7864e

• Package Template from NHS Digital's RAP Community of Practice

Note: No private or patient data are shared in this repository.

Folder Stucture

Name	Link	Description
.github/workflows	[Link]	Azure Data Factory notebooks for running ephemeral job clusters
nhspy-plotthedots	[Link]	Project folder
~/data	[Link]	Example datasets
~/dev	[Link]	For testing new code
~/utilities	[Link]	Helper functions
tests/unittests	[Link]	Unit testing framework

Built With

• Python 3

Getting Started

To get up and running follow these simple steps.

Installation

pip install --index-url https://test.pypi.org/simple/ --no-deps nhspy-plotthedots-test

Note this is the the test version of pypi, not for use in production.

Usage

Please refer to our Read the Docs site

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See CONTRIBUTING.md for detailed guidance.

License

Distributed under the MIT License. See LICENSE.md for more information.

About

Project contact email: craig.shenton@nhs.net

Acknowledgements

• Tom Jemmett
• NHS-R Community