Project Outline

To-dos

• Finish creating more detailed example scripts for template
• Continue having lab members test template (on different computing environments) and try to break it
• Finish refactoring textfill
• Continue adding unit tests and improve exception checks for unit tests intended to fail
• Consider adding minimum versions for required software (Python, Stata, R, Lyx, etc.)
• Add top level /examples/ directory containing modules illustrating lots of different use cases. Consider making the main repository modules use only Python + Latex and then use the /examples/ to illustrate Stata, R, Lyx, as well as other things like Matlab, etc. that we want to support
• Create version of repository that that only uses Stata and LyX
• Iterate on and improve get_modified_sources and check_module_size
• Create Python tool to map out module dependencies on other modules

See also "MG Template Notes" in Evernote.

See also Hunt's RA manual here

To add to RA manual

• Rules for raw data directories including readme.txt
• Each directory should be able to run on clean checkout of repo; so anything called by inputs.txt must be checked in
• config_user.yaml should never be committed
• Do not commit commented out code in major commits
• config.yaml should be a one stop shop for all repository-wide metadata. Metadata that pertains only to a single module can be stored in config_module.yaml at the top level of the module.