Skip to content
Public template

About

Template for creating new projects

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

17 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

[Project Title]

See examples

Authors: [Author 1], [Author 2], [Author 3], ...


Project Description

Brief description of the project.

  • Paper: [Insert link]
  • Repository: [Insert link]

1. Data

1a_raw

Raw input datasets:

  • [Dataset description]
  • [Source]

1b_intermediate

Processed/intermediate datasets:

  • [Description]

1c_support

Supporting files:

  • Boundaries, lookup tables, definitions, etc.

1d_summary

Final processed datasets:

  • Aggregated outputs
  • Key variables

2. Code

  • 2a_[script_name]: Description
  • 2b_[script_name]: Description
  • 2c_[script_name]: Description
  • 2d_[script_name]: Description
  • 2e_[script_name]: Description

Setup

  • Data preparation scripts
  • Helper functions

3. Output

  • 3a_[output_name]: Description
  • 3b_[output_name]: Description
  • 3c_[output_name]: Description
  • 3d_[output_name]: Description

4. Sensitivity Analysis

  • Description of robustness checks
  • Alternative assumptions

Directory Structure

├── 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


How to Run

git clone <repo_url> cd <repo_name>

Run setup scripts

Run analysis scripts


Dependencies

  • R / Python (specify version)

  • Key packages:

    • [package_1]
    • [package_2]

Data Availability

  • Dataset 1: [Link]
  • Dataset 2: [Link]
  • Dataset 3: [Link]

Include:

  • Time coverage
  • Resolution
  • Access notes

Citation

[Authors]. (Year). Title. Journal/Repository.


Contact

  • Name:
  • Email:
  • Institution:

About

Template for creating new projects

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages