https://github.com/nhs-transformation-unit/hsds_mash
Repository for all analysis, modelling and pathway mapping for the MASH pathway
https://github.com/nhs-transformation-unit/hsds_mash
Last synced: 7 months ago
JSON representation
Repository for all analysis, modelling and pathway mapping for the MASH pathway
- Host: GitHub
- URL: https://github.com/nhs-transformation-unit/hsds_mash
- Owner: NHS-Transformation-Unit
- License: gpl-3.0
- Created: 2024-07-01T09:48:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T10:15:22.000Z (over 1 year ago)
- Last Synced: 2024-12-28T00:46:32.635Z (over 1 year ago)
- Language: R
- Size: 2.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Horizon Scanning, Demand Signalling (HSDS): MASH Pathway Analysis and Modelling Repository
This repository contains the codebase for undertaking all analysis and modelling of the MASH pathway.
## Table of Contents
- [Repository Structure](#repository-structure)
- [Getting Started](#getting-started)
- [Contributors](#contributors)
- [License](#license)
## Repository Structure
The current structure of the repository is detailed below:
``` plaintext
├───README.md
├───LICENSE
├───.gitignore
├───.Rproj
├───data
├───raw
├───reference
└───theograph
├───documentation
└───project_documentation
├───images
└───theograph_example
└───src
├───config
├───outputs
├───requirements
├───results
├───charts
└───tables
└───scripts
├───analysis
├───etl
└───udal_extracts
├───processing
└───visualisation
```
- `README.md`: This file containing an overview and instructions for using the repository.
- `LICENSE`: License information for the repository.
- `.gitignore`: Specifies the files and folders that are ignored (not tracked) in the repository.
- `.Rproj`: The RStudio project file.
- `data`: Directory for data files used in the analysis
- `reference`: Any reference files such as geospatial datasets or data dictionary files used in the analysis.
- `documentation`: Additional documentation that is helpful for understanding and replicating analysis and modelling.
- `images`: Directory containing any logos and other images used in creating outputs for the repository.
- `src`: All source code used for any analysis and modelling. This is comprised of the following:
- `config`: Directory contains configuration files for outputs such as css and ggplot themes.
- `outputs`: Contains the output files used to render the analysis or modelling such as `.qmd` or `.rmd`
- `requirements`: Contains information on requirements for the repository. Scripts for required R packages and loading these into the environment.
- `results`: Outputs of analysis or modelling such as specific charts and tables to be rendered in the `outputs`.
- `scripts`: Directory containing the code used within the analysis and modelling. This is further broken down into:
1. `analysis`: Scripts for analysing MASH datasets.
2. `etl`: Scripts for loading datasets into environment.
3. `processing`: Scripts for processing and cleaning loaded datasets.
4. `visualisation`: Scripts for creating visualisations and functions for analysis.
## Getting Started
This analysis has been undertaken in R and RStudio. You will need to have these installed to replicate the analysis or use an alternative IDE. The R packages that are required for replicating analysis and modelling are documented within the `requirements` directory.
The repository can be cloned locally using:
```
git clone https://github.com/NHS-Transformation-Unit/HSDS_MASH.git
```
## Contributors
This repository has been created and developed by:
- [Andy Wilson](https://github.com/ASW-Analyst)
## License
This project is licensed under the **GPL-3.0 license** - see the `LICENSE` file for details.