README.md

DIL Analytics Manual

Repository featuring DIL Analytics Manual and its associated documents. To access the manual, go to devinnovationlab.github.io/guides/.

How to contribute

To make a suggestion, create an issue. To make direct contributions, create a fork, make your edits to the gh-pages branch, and open a pull request.

Internal vs. External Documents

Everything that is on the gh-pages branch is on the website and thus external. From there we link to internal documents (on the DIL git) if necessary.

File Structure

Proposed file structure to host all DIL "educational documents" and important example code from past DIL projects.

gh-pages branch       # DIL Analytics Manual
├── Principles of Analytics
├── Coding Guides # Detailed articles with general code snippets
│   |── Power calculations/ 	#
│   │   ├── Covariates
│   │   ├── ICC      	
│   │   ├── Panel RCT
│   │   ├── stratification
│   │   ├── Multiple Hypotheses Testing
├── DIL templates
├── External resources

main branch           # Root directory for lab guides
├── power_calc/       	# High-level document summarizing power calculations @ DIL (including step-by-step guidlines for project specific notebooks)
│   ├── shiny/       	# An interactive app that showcases all essential examples
│   ├── examples/     	# Example documents with replication that showcase power calculations from past DIL projects
│   │   ├── covariates.Rmd
│   │   ├── icc.Rmd
│   │   ├── panel_rct.Rmd
│   │   ├── stratification.Rmd
│   │   ├── mht.Rmd
│   ├── presentations/  # Slides for presentations on power calculations
├── spatial/			# GIS @ DIL (in progress)