hypergraph-mm holds supporting code for the "Transforming Healthcare Data with Graph-based Techniques Using SAIL DataBank" project including a copy of the framework built to perform the hypergraph calculations. It was undertaken over two internships:
- Jamie Burke (GitHub: jaburke166, Wave Three, July-December 2022) - currently on the
mainbranch of the repository - Zoe Hancox (GitHub: ZoeHancox, Wave Four, January-June 2023) - currently on the
zh-hypergraph-mm-mortbranch of the repository
The associated reports from these internships can be found in the reports folder on each branch.
A link to the original project proposal can be found here and an associated streamlit app explaining the methodology can be accessed here with its GitHub Repository is hypergraphical.
The repository also supports the work presented in the pre-print Representing multimorbid disease progressions using directed hypergraphs.
Note: Only public or fake data are shared in this repository.
Some of the data used in this project are available in the SAIL Databank at Swansea University, Swansea, UK. All proposals to use SAIL data are subject to review by an independent Information Governance Review Panel (IGRP). Before any data can be accessed, approval must be given by the IGRP. The IGRP carefully considers each project to ensure the proper and appropriate use of SAIL data. When approved, access is gained through a privacy-protecting trusted research environment (TRE) and remote access system referred to as the SAIL Gateway. SAIL has established an application process to be followed by anyone who would like to access data via SAIL - this study has been approved by the IGRP as project 1392.
The main code is found in the hypmm folder of the repository (see Usage below for more information)
.
├── docs # Documentation
├── notebooks # Notebooks
├── hypmm # Source files
├── .flake8
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENCE
├── mkdocs.yml
├── OPEN_CODE_CHECKLIST.md
├── README.md
└── requirements.txt
To get a local copy up and running follow these simple steps.
To clone the repo:
git clone https://github.com/nhsx/hypergraph-mm
To create a suitable environment we suggest:
- Build conda environment via
conda create --name hg-test python=3.8 - Activate environment
conda activate hg-test - Install requirements via
python -m pip install -r ./requirements.txt
The repository uses pre-commit hooks to enforce code style using Black, follows flake8, and performs a few other checks. See .pre-commit-config.yaml for more details. These hooks will also need installing locally via:
pre-commit autoupdate
pre-commit install
and then will be checked on commit.
See the examples in the notebooks folder for usage.
See the Issues in GitHub for a list of proposed features (and known issues).
Run tests by using pytest test/test.py in the top directory.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
See CONTRIBUTING.md for detailed guidance.
Unless stated otherwise, the codebase is released under the MIT Licence. This covers both the codebase and any sample code in the documentation.
See LICENCE for more information.
The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.
To find out more about the Digital Analytics and Research Team visit our project website or get in touch at [email protected].
This project makes use of anonymised data held in the SAIL Databank, which is part of the national e-health records research infrastructure for Wales. We would like to acknowledge all the data providers who make anonymised data available for research.