We are pleased to announce the v1.0 release of our Github template for doing reproducible research in HEGS! This version of the template integrates lessons learned from our experience from two years of doing reproduction studies, replication studies, and original research in the human-environment and geographical sciences. Our experience includes mentoring and teaching graduate and undergraduate students, working in research teams, and reformatting other researchers’ data and code to conform to our template. This release conforms more tightly to international metadata standards for projects (Dublin Core) and geographic data (ISO 191* series), and is easily integrated with OSF projects and registrations.
This release of the HEGSRR Template contains the following updates:
- template for project metadata in the main readme file
- markdown template for data metadata in the data/metadata directory
- changed the name of tables indexing data, metadata, and procedures from
*_index.csvand simplified the tables to avoid duplication with metadata documents
- revised and simplified template analysis plan in three formats: markdown, Rmarkdown, and Jupyter Python notebook
- additional code and guidance in R and Python for setting up, documenting, and reproducing computational environments
Our most recent reproduction study of Spielman et al 2020’s Evaluation of the Social Vulnerability Index implements this new version of the template. Compare the legibility of our reproduction research compendium to the original study’s GitHub repository. The original repository was remarkably complete for a geographic information science research paper, but still left plenty of work to be done.