🌐 US-Proxy
class="logged-out env-production page-responsive" style="word-wrap: break-word;" >
Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

32 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

project-template

version data BSD-3-Clause data CC-BY-4.0

Usage

git clone --depth=1 https://github.com/sboysel/project-template my-new-project
cd my-new-project
rm -rf .git
git init

Organization

project-template/
β”œβ”€β”€ conf              # project configuration files                
β”‚   β”œβ”€β”€ README.md
β”‚   └── main.toml
β”œβ”€β”€ data              # project data
β”‚   β”œβ”€β”€ output          # final data output
β”‚   β”œβ”€β”€ temp            # intermediate data objects
β”‚   β”œβ”€β”€ LICENSE         # data-specific license
β”‚   └── README.md
β”œβ”€β”€ doc               # project documentation and write-up
β”‚   β”œβ”€β”€ notes
β”‚   β”œβ”€β”€ paper
β”‚   β”œβ”€β”€ references
β”‚   β”œβ”€β”€ slides
β”‚   └── README.md
β”œβ”€β”€ log               # store for log files
β”œβ”€β”€ output            # final project outputs
β”‚   β”œβ”€β”€ figures
β”‚   └── tables
β”œβ”€β”€ src               # project source code
β”‚   β”œβ”€β”€ lib             # code shared across modules
β”‚   β”œβ”€β”€ modules         # project modules
β”‚   β”‚   β”œβ”€β”€ bar
β”‚   β”‚   β”œβ”€β”€ baz
β”‚   β”‚   └── foo
β”‚   β”œβ”€β”€ test            # unit tests, sanity checks, etc.
β”‚   β”œβ”€β”€ HEADER          # project source code license header
β”‚   └── README.md
β”œβ”€β”€ LICENSE           # project license: BSD-3 for source code, CC-BY-4.0 for data
β”œβ”€β”€ Makefile          # project build script (alternatives: simple scripts, other command runners)
β”œβ”€β”€ README.md         # top-level project README
└── TODO.md           # project TODO list

License

As suggested by the American Economic Association:

  • source code: BSD-3-Clause
  • data: CC-BY-4.0

About

A simple template for empirical research projects

Topics

Resources

Stars

2 stars

Watchers

1 watching

Forks

Used by

Contributors