This repository contains a barebones framework for analyses and tutorials from the Asthma Collaboratory.
The initial directory structure is shown below. Feel free to adapt it to your needs.
โโโ LICENSE # defaults to GPL v3
โโโ README.md # a top-level README for developers using this project
โโโ DESCRIPTION # a package header for R (not useful otherwise)
โโโ .gitignore # all files that Git should _not_ commit
โโโ .travis.yaml # build configuration for TravisCI
โโโ run_analysis.sh # user-friendly button to push for running all analysis steps
โโโ env.sh # a template script for seeding environment variables; save as ".env"
โ
โโโ analysis
โ โโโ bin # any binaries (downloaded, softlinked, or otherwise) for the project
โ โโโ data # all data necessary for project
โ โโโ results # a folder for all analysis results
โ โโโ figures # generated graphics and figures to be used in reporting
โ
โโโ docs # a place to store documentation (Sphinx, Jupyter notebooks, etc.)
โ
โโโ src # all source code for the analysis, with 1 folder per step
โ โโโ 01_step1
โ โ โโโ 01_run_step1.sh
โ โโโ 02_step2
โ โ โโโ 01_run_step2.sh # notice that each substep of a step is ordered numerically starting from 1
โ โโโ 03_step3
โ โ โโโ 01_run_step3.sh