This repository contains the codebase for the modelling of an example 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.
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.
The structure of this repository is detailed below:
├───data
├───documentation
├───guidance
└───project_documentation
├───images
├───logos
└───pathway
└───src
├───config
├───model_inputs
└───outputs
├───load
├───model
├───outputs
├───processing
└───requirements
To contain any datasets received from the client to support the model build or underpinning assumptions.
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 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.
All code is stored in src. This is subdivided into six modules:
config
: Files for configuring the output such as thetheme.css
are stored in theoutputs
folder. Themodel_inputs
folder contains the code for setting inputs for the model which can be changed here by the user.load
: Files for loading any datasets from thedata
folder are stored here.model
: Files for building and running the pathway model are stored here.outputs
: Files for creating the outputs of the model are stored here.processing
: Processing steps such as cleaning or feature creation on any data loaded into the model are stored here.requirements
: The requirements folder stores thepackages.R
file containing the list of packages required to run the model.
The pathway below represents the to-be pathway that is being modelled:
This repository has been created and developed by: