/HEGSRR-Template

Template documents and packages for study pre-registration, reproductions, and replications

Primary LanguageJupyter NotebookBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

If you use this template for research, please cite it:

Kedron, P., & Holler, J. (2023). Template for Reproducible and Replicable Research in Human-Environment and Geographical Sciences. https://doi.org/10.17605/OSF.IO/W29MQ

Title of Study

Contributors

  • First Name Last Name*, email address, @githubname, ORCID link, affiliated institution(s)
  • First Name Last Name, email address, @githubname, ORCID link, affiliated institution(s)

* Corresponding author and creator

Abstract

Write a brief abstract about your research project. If the project is a reproduction or replication study, include the full citation with a statement This study is a reproduction/replication of:

citation to prior study

A graphical abstract of the study could also be included as an image here.

Study Metadata

  • Key words: Comma-separated list of keywords (tags) for searchability. Geographers often use one or two keywords each for: theory, geographic context, and methods.
  • Subject: select from the BePress Taxonomy
  • Date created: date when project was started
  • Date modified: date of most recent revision
  • Spatial Coverage: Specify the geographic extent of your study. This may be a place name and link to a feature in a gazetteer like GeoNames or OpenStreetMap, or a well known text (WKT) representation of a bounding box.
  • Spatial Resolution: Specify the spatial resolution as a scale factor, description of the level of detail of each unit of observation (including administrative level of administrative areas), and/or or distance of a raster GRID size
  • Spatial Reference System: Specify the geographic or projected coordinate system for the study
  • Temporal Coverage: Specify the temporal extent of your study---i.e. the range of time represented by the data observations.
  • Temporal Resolution: Specify the temporal resolution of your study---i.e. the duration of time for which each observation represents or the revisit period for repeated observations
  • Funding Name: name of funding for the project
  • Funding Title: title of project grant
  • Award info URI: web address for award information
  • Award number: award number

Related to

  • OSF Project:
  • Pre-analysis Registration:
  • Post-analysis Report Registration:
  • Preprint:
  • Conference Presentation:
  • Publication:
  • Prior Study:
  • ...:

Metadata for access

  • Rights: LICENSE: BSD 3-Clause "New" or "Revised"
  • Resource type: Collection
  • Resource language: English
  • Conforms to: Template for Reproducible and Replicable Research in Human-Environment and Geographical Sciences version 1.0, DOI:10.17605/OSF.IO/W29MQ

Compendium structure and contents

This research compendium is structured with four main directories:

  • data: contains subdirectories for raw data and derived data.
  • docs: contains subdirectories for manuscript, presentation, and report
  • procedure: contains subdirectories for code or software scripts, information about the computational environment in which the research was conducted, and non-code research protocols
  • results: contains subdirectories for figures, formatted data tables, or other formats of research results.

The data, procedures, and results of this repository are outlined in three tables:

Important local documents include:

Compendium reference

The template_readme.md file contains more information on the design of this template and references used in the design. The Template_LICENSE file provides the BSD 3-Clause license for using this template. To cite the template, please use template_reference.bib or:

Kedron, P., & Holler, J. (2023). Template for Reproducible and Replicable Research in Human-Environment and Geographical Sciences. https://doi.org/10.17605/OSF.IO/W29MQ