From b4730f6ea877cd552e6706fc335901655abc6cae Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Mon, 15 Jul 2024 21:38:05 +0200 Subject: [PATCH] fix(repo): Rename all references to data and output dir --- README.md | 6 ++--- _quarto-article.yml | 4 +-- _quarto-workingpaper.yml | 4 +-- _quarto.yml | 4 +-- article.qmd | 12 ++++----- documentation/findings-per-policy-area.md | 2 +- documentation/validity_tool.md | 2 +- final_document/meeting_eoy.html | 6 ++--- final_document/notes.html | 6 ++--- final_document/scoping_review.html | 32 +++++++++++------------ meeting_eoy.qmd | 6 ++--- notebooks/bibmanip.qmd | 4 +-- notebooks/explore.qmd | 4 +-- notebooks/main-findings.qmd | 4 +-- notebooks/rank_validities.qmd | 2 +- notebooks/test-magma.qmd | 4 +-- notes.qmd | 6 ++--- pyproject.toml | 6 ++--- scoping_review.qmd | 16 ++++++------ src/extract/load_data.py | 2 +- src/globals.py | 2 +- src/model/prisma.py | 2 +- 22 files changed, 67 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 5c5b1e5..24d2ff9 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ 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 `02-data/` directory: +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 `02-data/` directory and turn it into `.csv` data, +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 @@ -35,6 +35,6 @@ Now, by invoking `make` the project can be rendered: 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. +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`. diff --git a/_quarto-article.yml b/_quarto-article.yml index c72ab84..8a59168 100644 --- a/_quarto-article.yml +++ b/_quarto-article.yml @@ -16,11 +16,11 @@ format: theme: darkly docx: filters: - # - pandoc-to-zotero-live + - pandoc-to-zotero-live - docx-landscape echo: false number-sections: true - reference-doc: 02-data/supplementary/justified.docx + reference-doc: data/supplementary/justified.docx elsevier-pdf: echo: false number-sections: true diff --git a/_quarto-workingpaper.yml b/_quarto-workingpaper.yml index 42c8214..d5fc77e 100644 --- a/_quarto-workingpaper.yml +++ b/_quarto-workingpaper.yml @@ -1,6 +1,4 @@ project: - title: "Key terms and definitions" - output-dir: 04-outputs render: - presentation_summary.md - notes.qmd @@ -21,7 +19,7 @@ format: docx: echo: false number-sections: true - reference-doc: 02-data/supplementary/justified.docx + reference-doc: data/supplementary/justified.docx filters: - pandoc-to-zotero-live - docx-landscape diff --git a/_quarto.yml b/_quarto.yml index 9b5381f..f73a003 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -1,8 +1,8 @@ project: - output-dir: 04-outputs + output-dir: output execute-dir: project -bibliography: 02-data/intermediate/zotero-library.bib +bibliography: data/intermediate/zotero-library.bib csl: /home/marty/documents/library/utilities/styles/APA-7.csl zoterolive: library: wow-inequalities diff --git a/article.qmd b/article.qmd index 79b4ca4..6032a1a 100644 --- a/article.qmd +++ b/article.qmd @@ -102,7 +102,7 @@ with a focus on the narrowing criteria specified in @tbl-inclusion-criteria. ::: {#tbl-inclusion-criteria} ```{python} -inclusion_criteria = pd.read_csv("02-data/supplementary/inclusion-criteria.tsv", sep="\t") +inclusion_criteria = pd.read_csv("data/supplementary/inclusion-criteria.tsv", sep="\t") Markdown(tabulate(inclusion_criteria, showindex=False, headers="keys", tablefmt="grid")) ``` @@ -152,7 +152,7 @@ ultimately resulting in the process represented in the PRISMA chart in @fig-pris ```{mermaid} %%| label: fig-prisma %%| fig-cap: PRISMA flowchart for scoping process -%%| file: 02-data/processed/prisma.mmd +%%| file: data/processed/prisma.mmd ``` All relevant data concerning both their major findings and statistical significance are then extracted from the individual studies into a collective results matrix. @@ -225,7 +225,7 @@ def strength_for(val): ] -findings_institutional = pd.read_csv("02-data/supplementary/findings-institutional.csv") +findings_institutional = pd.read_csv("data/supplementary/findings-institutional.csv") outp = Markdown( tabulate( @@ -695,7 +695,7 @@ Another reason could be the actual implementation of different policy programmes ::: {#appatbl-wow-terms} ```{python} -terms_wow = pd.read_csv("02-data/supplementary/terms_wow.csv") +terms_wow = pd.read_csv("data/supplementary/terms_wow.csv") Markdown(tabulate(terms_wow.fillna(""), showindex=False, headers="keys", tablefmt="grid")) ``` @@ -706,7 +706,7 @@ World of work term cluster ::: {#appatbl-intervention-terms} ```{python} -terms_policy = pd.read_csv("02-data/supplementary/terms_policy.csv") +terms_policy = pd.read_csv("data/supplementary/terms_policy.csv") # different headers to include 'social norms' headers = ["General", "Institutional", "Structural", "Agency & social norms"] Markdown(tabulate(terms_policy.fillna(""), showindex=False, headers=headers, tablefmt="grid")) @@ -719,7 +719,7 @@ Policy intervention term cluster ::: {#appatbl-inequality-terms} ```{python} -terms_inequality = pd.read_csv("02-data/supplementary/terms_inequality.csv") +terms_inequality = pd.read_csv("data/supplementary/terms_inequality.csv") Markdown(tabulate(terms_inequality.fillna(""), showindex=False, headers="keys", tablefmt="grid")) ``` diff --git a/documentation/findings-per-policy-area.md b/documentation/findings-per-policy-area.md index e19ce75..66b5eb7 100644 --- a/documentation/findings-per-policy-area.md +++ b/documentation/findings-per-policy-area.md @@ -1,6 +1,6 @@ # Summary of study findings -written into 02-data/supplementary/findings-*.csv tables +written into data/supplementary/findings-*.csv tables ## Institutional diff --git a/documentation/validity_tool.md b/documentation/validity_tool.md index 83c8e7a..78b2916 100644 --- a/documentation/validity_tool.md +++ b/documentation/validity_tool.md @@ -1,6 +1,6 @@ # Validity estimators -For a general concept description see ../03-documentation/terms_of_reference-key_terms.md#validity +For a general concept description see ../documentation/terms_of_reference-key_terms.md#validity From Maitrot2017 -> Section 4, Figure 3 and Appendix table notes They rank *only* quasi-experimental/experimental diff --git a/final_document/meeting_eoy.html b/final_document/meeting_eoy.html index 8cd52b7..9460b9f 100644 --- a/final_document/meeting_eoy.html +++ b/final_document/meeting_eoy.html @@ -3757,7 +3757,7 @@ window.document.addEventListener("DOMContentLoaded", function (event) { });