Skip to content

MaykolMedrano/projectinit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

projectinit

Professional Stata Project Structure Initializer. One-click reproducible research infrastructure following J-PAL, DIME (World Bank), and AEA Data Editor standards.

Version Stata Tests passing Stars License: MIT


Features

  • J-PAL/DIME/AEA Standards: Numbered folders (01_Data, 02_Scripts, 03_Outputs)
  • LaTeX Integration: PUC thesis and standard templates with automatic macro generation
  • GitHub Automation: One-command repository creation and deployment
  • Bilingual Support: English/Spanish interfaces
  • Cross-Platform: Windows, macOS, Linux compatible

Installation

Net Install (Recommended)

net install projectinit, from("https://raw.githubusercontent.com/MaykolMedrano/projectinit/master/installation")

Manual Installation

  1. Download projectinit.ado and projectinit.sthlp from installation/
  2. Copy to your Stata ado directory:
    • Windows: C:\ado\plus\p\
    • Mac: ~/Library/Application Support/Stata/ado/plus/p/
    • Linux: ~/.stata/ado/plus/p/

Quick Start

* Basic project
projectinit "MyResearch", root("C:/Research")

* Full setup with LaTeX, GitHub, and replication package
projectinit "PhD_Dissertation", ///
    root("C:/Research") ///
    lang(en) ///
    latex(puc) ///
    github(private) ///
    replicate ///
    verbose

Project Structure

YourProject/
β”œβ”€β”€ run.do                    # Master execution script
β”œβ”€β”€ README.md                 # Project documentation
β”œβ”€β”€ .gitignore
β”œβ”€β”€ 01_Data/
β”‚   β”œβ”€β”€ Raw/                 # Original, immutable data
β”‚   β”œβ”€β”€ De-identified/       # Anonymized data
β”‚   β”œβ”€β”€ Intermediate/        # Processed data
β”‚   └── Final/               # Analysis-ready datasets
β”œβ”€β”€ 02_Scripts/
β”‚   β”œβ”€β”€ Ados/                # Custom programs
β”‚   β”œβ”€β”€ Data_Preparation/    # Cleaning scripts
β”‚   β”œβ”€β”€ Analysis/            # Main analysis
β”‚   └── Validation/          # Robustness checks
β”œβ”€β”€ 03_Outputs/
β”‚   β”œβ”€β”€ Tables/              # LaTeX/CSV tables
β”‚   β”œβ”€β”€ Figures/             # PDF/PNG figures
β”‚   └── Logs/                # Execution logs
β”œβ”€β”€ 04_Writing/              # LaTeX manuscript (if latex() used)
β”œβ”€β”€ 05_Doc/                  # Documentation, codebooks, IRB
└── 06_Replication/          # AEA-compliant package (if replicate used)

Command Reference

Syntax

projectinit projectname, root(string) [options]

Options

Option Values Default Description
root() path required Parent directory for project
lang() en | es en Interface language
latex() puc | standard none LaTeX template
github() public | private none Create GitHub repository
author() "name" username Author name
email() "email" β€” Contact email
replicate β€” β€” Include AEA replication package
overwrite β€” β€” Overwrite existing project
verbose β€” β€” Display detailed output

Best Practices

  • Never modify raw data β€” Keep 01_Data/Raw/ untouched
  • Use dynamic paths β€” Always use globals from run.do
  • Set random seeds β€” Ensures reproducible results
  • Document dependencies β€” List all packages in run.do
  • Version control β€” Use git to track changes

For detailed workflow and AEA compliance guidelines, run help projectinit in Stata.


Citation

@software{projectinit2026,
  author = {Maykol Medrano},
  title = {projectinit: Professional Stata Project Structure Initializer},
  version = {2.1.0},
  year = {2026},
  url = {https://github.com/MaykolMedrano/projectinit}
}

Contributing

  1. Fork the repository
  2. Create feature branch: git checkout -b feature/NewFeature
  3. Commit changes: git commit -m 'Add NewFeature'
  4. Push: git push origin feature/NewFeature
  5. Open Pull Request

Acknowledgments

Built following best practices from:

  • J-PAL (MIT) β€” Abdul Latif Jameel Poverty Action Lab
  • DIME (World Bank) β€” Development Impact Evaluation
  • AEA Data Editor β€” American Economic Association
  • Gentzkow & Shapiro (2014) β€” "Code and Data for the Social Sciences"

License

MIT License β€” See LICENSE for details.


Version: 2.1.0 | Stata: 14+ | Changelog: CHANGELOG.md

About

Professional Stata Project Structure Initializer following J-PAL, DIME, and AEA standards

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors