From 72f5ccfe61d6851da4eef3253178eecdabb0600b Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Thu, 20 Jun 2024 11:01:54 +0200 Subject: [PATCH] feat(repo): Add simple explanatory README file --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..da43d0e --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Scoping Review: Inequalities on the Labour Market + +This repository contains all data, modelling and processing source code and the complete textual content to reproduce the scoping review study. + +Raw, intermediate and processed data can all be found in the `02-data/` directory: +Raw data include the unmodified database queries using the scoping review search terms. +Intermediate data are made up of the bibtex file produced by Zotero, after tagging and sorting in a Zotero library, ready to be re-imported into the application. +Processed data include the fully extracted studies which make up the main sample for the review. + +The full article text and code can be found in the `scoping_review.qmd` file. +It makes use of supplementary processing code which resides in the `src/` directory, +mainly to load processed data from the `02-data/` directory and turn it into `.csv` data, +as well as pre-processing those for visualization and validity ranking within the study. + +## Execution and Reproduction + +To reproduce the content herein, there are 3 requirements: + +- [Python](https://www.python.org/) (minimum version 3.11) +- [Poetry package manager](https://python-poetry.org/) +- [Quarto publishing system](https://quarto.org/) + +Once you have all required software to install all necessary package dependencies, +invoke poetry from the main repository directory: + +```bash +poetry install +``` + +Now, by invoking `make` the project can be rendered: + +```bash +make +``` + +Make will by default extract the processed data and use it to render the full project into a pdf, an html and a docx version of the review, which are deposited in the `04-outputs/` directory. + +You can invoke any of the `extract`, `render`, `release` steps manually instead by executing e.g. `make extract`.