wow-inequalities/README.md

# 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.
The most up-to-date version of this repository can always be found [here](https://git.martyoeh.me/professional/wow-inequalities).

Raw, intermediate and processed data can all be found in the `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 `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 `outputs/` directory.

You can invoke any of the `extract`, `render`, `release` steps manually instead by executing e.g. `make extract`.