Repo organization
Info
The ๐๐ฅ๐ข๐๐๐๐ญ๐๐ฉ template is still a work in progress. Check back later!
This page describes the directory structure of the template.
ยง1. Repo configuration files¶
local.yml¶
TBD
project.yml¶
TBD
.gitignore¶
TBD
.gitattributes¶
TBD
ยง2. Template helper scripts¶
Pipeline library¶
Utility library¶
ยง3. Documentation¶
README.md¶
MODULE_README.md¶
docs/: Documents¶
TBD
ยง4. Data storage¶
01_raw/¶
02_destination/¶
03_external/¶
ยง5. Module structure¶
Each module follows a consistent structure:
input/¶
Data or other inputs used by the module (symlinked from elsewhere).
source/¶
Scripts for generating outputs (e.g. data cleaning, analysis, or figures).
source/archive/¶
source/assets/¶
Static resources used in outputs (e.g. images, logos, icons).
output/¶
Outputs generated by the module (e.g. cleaned datasets, tables, figures).
output/log/¶
output/temp/¶
Temporary files.
Makefile¶
Defines rules for building outputs from inputs using scripts in source/.