https://github.com/nhs-transformation-unit/cmca_hysteroscopy
Repository containing the codebase for modelling the proposed hysteroscopy pathway
https://github.com/nhs-transformation-unit/cmca_hysteroscopy
discrete-event-simulation pathway-models r
Last synced: 2 months ago
JSON representation
Repository containing the codebase for modelling the proposed hysteroscopy pathway
- Host: GitHub
- URL: https://github.com/nhs-transformation-unit/cmca_hysteroscopy
- Owner: NHS-Transformation-Unit
- License: gpl-3.0
- Created: 2024-02-13T13:48:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-18T16:16:33.000Z (about 1 year ago)
- Last Synced: 2024-12-28T00:46:34.467Z (4 months ago)
- Topics: discrete-event-simulation, pathway-models, r
- Language: R
- Size: 1.22 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cheshire & Merseyside Cancer Alliance Hysteroscopy Pathway Modelling
This repository contains the codebase for the modelling of the proposed re-designed Hysteroscopy pathway. This model has been developed in R, details on the structure of the repository and how to amend and run the model are detailed below.
## Using the Repository
The repository can be cloned to run the pathway model. Changing the inputs in the `config` folder will enable alternate scenarios of the pathway to be run.
## Repository Structure
The structure of this repository is detailed below:
``` plaintext
├───data
├───documentation
├───guidance
└───project_documentation
├───images
├───logos
└───pathway
└───src
├───config
├───model_inputs
└───outputs
├───load
├───model
├───outputs
├───processing
└───requirements
```
### `data`
To contain any datasets received from the client to support the model build or underpinning assumptions.
### `documentation`
Contains the project documentation such as specification of the model within the `project_documentation` folder. The `guidance` folder contains information on model structure and how to run.
### `images`
Images such as TU logos and branding to add to outputs are contained in the `logos` folder. The `pathway` folder hosts the **draw.io** outputs of the proposed pathway that has been modelled.
### `src`
All code is stored in src. This is subdivided into six modules:
1. `config`: Files for configuring the output such as the `theme.css` are stored in the `outputs` folder. The `model_inputs` folder contains the code for setting inputs for the model which can be changed here by the user.
2. `load`: Files for loading any datasets from the `data` folder are stored here.
3. `model`: Files for building and running the pathway model are stored here.
4. `outputs`: Files for creating the outputs of the model are stored here.
5. `processing`: Processing steps such as cleaning or feature creation on any data loaded into the model are stored here.
6. `requirements`: The requirements folder stores the `packages.R` file containing the list of packages required to run the model.
## Proposed Pathway to Model
The pathway below represents the _to-be_ pathway that is being modelled:
## Contributors
This repository has been created and developed by:
- [Andy Wilson](https://github.com/ASW-Analyst)
- [Elliot Royle](https://github.com/elliotroyle)