Skip to content
Code for generating dataset documentation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
medsldocs
output
schema
.gitignore
LICENSE
Pipfile
Pipfile.lock
README.md

README.md

documentation

This repo holds a Python module for generating MEDSL dataset documentation. Specifically, four files for each dataset:

  • Release notes
  • Coverage notes
  • Codebook
  • R documentation

The module also generates the README.md for the precinct-returns repo.

The approach is to fill Jinja2 templates with metadata defined in YAML.

Organization:

├── medsldocs           # The module (Python)
│   ├── metadata        # Data about data (YAML)
│   │   ├── candidates  # ... candidates
│   │   ├── dataset     # ... datasets
│   │   │   └── common  # 
│   │   └── elections   # ... offices and districts
│   ├── templates       # Templates (Jinja2)
│   └── test            # Test suite (Python)
└── output              # Generated documentation (Markdown, Rd)

Run:

python -m medsldocs
You can’t perform that action at this time.