alermann-henestrosa/Data_Descriptor_HMC
alermann-henestrosa/Data_Descriptor_HMC
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add README with folder structure to repo

Browse Source
This commit is contained in:
Nora Wickelmaier 2025-10-14 17:07:09 +02:00
parent 79629447c9
commit 6620ddaa34
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md Normal file
View File

@ -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.