See examples
- https://github.com/sparklabnyc/usa_natality_complications_2026 for a health data-based project and
- https://github.com/sparklabnyc/global_tc_2024 for exposure data-based project
Authors: [Author 1], [Author 2], [Author 3], ...
Brief description of the project.
- Paper: [Insert link]
- Repository: [Insert link]
Raw input datasets:
- [Dataset description]
- [Source]
Processed/intermediate datasets:
- [Description]
Supporting files:
- Boundaries, lookup tables, definitions, etc.
Final processed datasets:
- Aggregated outputs
- Key variables
- 2a_[script_name]: Description
- 2b_[script_name]: Description
- 2c_[script_name]: Description
- 2d_[script_name]: Description
- 2e_[script_name]: Description
- Data preparation scripts
- Helper functions
- 3a_[output_name]: Description
- 3b_[output_name]: Description
- 3c_[output_name]: Description
- 3d_[output_name]: Description
- Description of robustness checks
- Alternative assumptions
├── 01_data │ ├── 1a_raw │ ├── 1b_intermediate │ ├── 1c_support │ ├── 1d_summary ├── 02_code │ ├── setup │ ├── scripts ├── 03_output │ ├── figures │ ├── tables ├── 04_sensitivity ├── shiny_app (optional) ├── README.md
git clone <repo_url> cd <repo_name>
-
R / Python (specify version)
-
Key packages:
- [package_1]
- [package_2]
- Dataset 1: [Link]
- Dataset 2: [Link]
- Dataset 3: [Link]
Include:
- Time coverage
- Resolution
- Access notes
[Authors]. (Year). Title. Journal/Repository.
- Name:
- Email:
- Institution: