From 6620ddaa34d8f4e9ac0726e3444e5387f5aae627 Mon Sep 17 00:00:00 2001 From: nwickel Date: Tue, 14 Oct 2025 17:07:09 +0200 Subject: [PATCH] Add README with folder structure to repo --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..906fb49 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Repository for collaboration on Data Descriptor paper for the HMC project + +The workflow is as follows: + +* Only make changes to `manuscript.Rnw` +* Then run this in R with `Sweave("manuscript.Rnw")` +* Then build `manuscript.tex` with pdflatex + +## Folder structure + +In order to create tables and figures, the repository `Data_Descriptor_HMC` must +be in the same folder as the `data` folder containing the cleaned data for all +waves of the HMC project. + +Hence, the folder structure on your machine should look like this: + +``` +Data_Descriptor_HMC +|-- manuscript.pdf +|-- manuscript.Rnw +|-- manuscript.tex +|-- README.md +data +|-- 03_cleaned_data +| |-- HMC_wave1_cleaned.csv +| |-- HMC_wave2_cleaned.csv +| |-- HMC_wave3_cleaned.csv +| |-- HMC_wave4_cleaned.csv +| |-- HMC_wave5_cleaned.csv +| |-- HMC_wave6_cleaned.csv +``` + +Later on both repositories will be added to the HMC organisation on Gitea: +https://gitea.iwm-tuebingen.de/HMC. +