Templates for developing and versioning data standards and reporting formats using GitHub

Crystal-Ornelas, Robert; Varadharajan, Charuleka; Bond-Lamberty, Ben; Boye, Kristin; Burrus, Madison; Cholia, Shreyas; Crow, Michael; Damerow, Joan; Davarakonda, Ranjeet; Ely, Kim S.; Goldman, Amy; Heinz, Susan; Hendrix, Valerie; Kakalia, Zarine; Pennington, Stephanie; Robles, Emily; Rogers, Alistair; Simmonds, Maegen; Velliquette, Terri; Weierbach, Helen; Weisenhorn, Pamela; Welch, Jessica N.; Agarwal, Deborah A.

doi:10.15485/1780564

Title: Templates for developing and versioning data standards and reporting formats using GitHub

Dataset
Other Related Research

Abstract

This data package contains three templates that can be used for creating README files and Issue Templates, written in the markdown language, that support community-led data reporting formats. We created these templates based on the results of a systematic review (see related references) that explored how groups developing data standard documentation use the Version Control platform GitHub, to collaborate on supporting documents. Based on our review of 32 GitHub repositories, we make recommendations for the content of README Files (e.g., provide a user license, indicate how users can contribute) and so 'README_template.md' includes headings for each section. The two issue templates we include ('issue_template_for_all_other_changes.md' and 'issue_template_for_documentation_change.md') can be used in a GitHub repository to help structure user-submitted issues, or can be modified to suit the needs of data standard developers. We used these templates when establishing ESS-DIVE's community space on GitHub (https://github.com/ess-dive-community) that includes documentation for community-led data reporting formats. We also include file-level metadata 'flmd.csv' that describes the contents of each file within this data package. Lastly, the temporal range that we indicate in our metadata is the time range during which we searched for data standards documented on GitHub.

Authors:

;

Lawrence Berkeley National Laboratory; Lawrence Berkeley National Laboratory
Lawrence Berkeley National Laboratory
Pacific Northwest National Laboratory (PNNL)
SLAC National Accelerator Laboratory
Lawrence Berkeley National Lab - NERSC
Oak Ridge National Laboratory
Brookhaven National Lab
Argonne National Laboratory

Publication Date:: Fri Jan 01 04:00:00 UTC 2021

Research Org.:: Environmental System Science Data Infrastructure for a Virtual Ecosystem; Environmental Systems Science Data Infrastructure for a Virtual Ecosystem

Sponsoring Org.:: U.S. DOE > Office of Science > Biological and Environmental Research (BER)

Subject:: 54 ENVIRONMENTAL SCIENCES; FAIR data; data reporting formats; data repositories; data standards; metadata; open science; trust principles

OSTI Identifier:: 1780564

DOI:: https://doi.org/10.15485/1780564

Citation Formats


                    Crystal-Ornelas, Robert, Varadharajan, Charuleka, Bond-Lamberty, Ben, Boye, Kristin, Burrus, Madison, Cholia, Shreyas, Crow, Michael, Damerow, Joan, Davarakonda, Ranjeet, Ely, Kim S., Goldman, Amy, Heinz, Susan, Hendrix, Valerie, Kakalia, Zarine, Pennington, Stephanie, Robles, Emily, Rogers, Alistair, Simmonds, Maegen, Velliquette, Terri, Weierbach, Helen, Weisenhorn, Pamela, Welch, Jessica N., and Agarwal, Deborah A. Templates for developing and versioning data standards and reporting formats using GitHub.  United States: N. p., 2021. 
        Web.  doi:10.15485/1780564.

Copy to clipboard


                    Crystal-Ornelas, Robert, Varadharajan, Charuleka, Bond-Lamberty, Ben, Boye, Kristin, Burrus, Madison, Cholia, Shreyas, Crow, Michael, Damerow, Joan, Davarakonda, Ranjeet, Ely, Kim S., Goldman, Amy, Heinz, Susan, Hendrix, Valerie, Kakalia, Zarine, Pennington, Stephanie, Robles, Emily, Rogers, Alistair, Simmonds, Maegen, Velliquette, Terri, Weierbach, Helen, Weisenhorn, Pamela, Welch, Jessica N., & Agarwal, Deborah A. Templates for developing and versioning data standards and reporting formats using GitHub.  United States.  doi:https://doi.org/10.15485/1780564

Copy to clipboard


                    Crystal-Ornelas, Robert, Varadharajan, Charuleka, Bond-Lamberty, Ben, Boye, Kristin, Burrus, Madison, Cholia, Shreyas, Crow, Michael, Damerow, Joan, Davarakonda, Ranjeet, Ely, Kim S., Goldman, Amy, Heinz, Susan, Hendrix, Valerie, Kakalia, Zarine, Pennington, Stephanie, Robles, Emily, Rogers, Alistair, Simmonds, Maegen, Velliquette, Terri, Weierbach, Helen, Weisenhorn, Pamela, Welch, Jessica N., and Agarwal, Deborah A. 2021.  
"Templates for developing and versioning data standards and reporting formats using GitHub".  United States.  doi:https://doi.org/10.15485/1780564.  https://www.osti.gov/servlets/purl/1780564. Pub date:Fri Jan 01 04:00:00 UTC 2021

Copy to clipboard


                    
@article{osti_1780564,

  title        = {Templates for developing and versioning data standards and reporting formats using GitHub},

  author       = {Crystal-Ornelas, Robert and Varadharajan, Charuleka and Bond-Lamberty, Ben and Boye, Kristin and Burrus, Madison and Cholia, Shreyas and Crow, Michael and Damerow, Joan and Davarakonda, Ranjeet and Ely, Kim S. and Goldman, Amy and Heinz, Susan and Hendrix, Valerie and Kakalia, Zarine and Pennington, Stephanie and Robles, Emily and Rogers, Alistair and Simmonds, Maegen and Velliquette, Terri and Weierbach, Helen and Weisenhorn, Pamela and Welch, Jessica N. and Agarwal, Deborah A.},

  abstractNote = {This data package contains three templates that can be used for creating README files and Issue Templates, written in the markdown language, that support community-led data reporting formats. We created these templates based on the results of a systematic review (see related references) that explored how groups developing data standard documentation use the Version Control platform GitHub, to collaborate on supporting documents. Based on our review of 32 GitHub repositories, we make recommendations for the content of README Files (e.g., provide a user license, indicate how users can contribute) and so 'README_template.md' includes headings for each section. The two issue templates we include ('issue_template_for_all_other_changes.md' and 'issue_template_for_documentation_change.md') can be used in a GitHub repository to help structure user-submitted issues, or can be modified to suit the needs of data standard developers. We used these templates when establishing ESS-DIVE's community space on GitHub (https://github.com/ess-dive-community) that includes documentation for community-led data reporting formats. We also include file-level metadata 'flmd.csv' that describes the contents of each file within this data package. Lastly, the temporal range that we indicate in our metadata is the time range during which we searched for data standards documented on GitHub.},

  doi          = {10.15485/1780564},

  journal      = {},

  number       = ,

  volume       = ,

  place        = {United States},

  year         = {Fri Jan 01 04:00:00 UTC 2021},

  month        = {Fri Jan 01 04:00:00 UTC 2021}

}

Copy to clipboard

Dataset:

View Dataset

DOI: https://doi.org/10.15485/1780564

Save / Share:

Export Metadata

Save to My Library

Similar records in DOE Data Explorer and OSTI.GOV collections:

Data from: "A guide to using GitHub for developing and versioning data standards and reporting formats"

Dataset Crystal-Ornelas, Robert ; Varadharajan, Charuleka ; Bond-Lamberty, Ben ; ...

These data are the results of a systematic review that investigated how data standards and reporting formats are documented on the version control platform GitHub. Our systematic review identified 32 data standards in earth science, environmental science, and ecology that use GitHub for version control of data standard documents. In our analysis, we characterized the documents and content within each of the 32 GitHub repositories to identify common practices for groups that version control their documents on GitHub.In this data package, there are 8 CSV files that contain data that we characterized from each repository, according to the location withinmore »« less
A guide to using GitHub for developing and versioning data standards and reporting formats

Journal Article Crystal‐Ornelas, Robert ; Varadharajan, Charuleka ; Bond‐Lamberty, Ben ; ... - Earth and Space Science

Data standardization combined with descriptive metadata facilitate data reuse, which is the ultimate goal of the Findable, Accessible, Interoperable, and Reusable (FAIR) principles. Community data or metadata standards are increasingly created through an approach that emphasizes collaboration between various stakeholders. Such an approach requires platforms for collaboration on the development process that centers on sharing information and receiving feedback. Our objective in this study was to conduct a systematic review to identify data standards and reporting formats that use version control for developing data standards and to summarize common practices, particularly in earth and environmental sciences. Of 108 data standardsmore »« less
A Guide to Using GitHub for Developing and Versioning Data Standards and Reporting Formats

Journal Article Crystal‐Ornelas, Robert ; Varadharajan, Charuleka ; Bond‐Lamberty, Ben ; ... - Earth and Space Science

Data standardization combined with descriptive metadata facilitate data reuse, which is the ultimate goal of the Findable, Accessible, Interoperable, and Reusable (FAIR) principles. Community data or metadata standards are increasingly created through an approach that emphasizes collaboration between various stakeholders. Such an approach requires platforms for collaboration on the development process that centers on sharing information and receiving feedback. Our objective in this study was to conduct a systematic review to identify data standards and reporting formats that use version control for developing data standards and to summarize common practices, particularly in earth and environmental sciences. Of 108 data standardsmore »« less
A Guide to Using GitHub for Developing and Versioning Data Standards and Reporting Formats

Journal Article Crystal-Ornelas, Robert ; Varadharajan, Charuleka ; Bond-Lamberty, Ben ; ... - Earth and Space Science

Data standardization combined with descriptive metadata facilitate data reuse, which is the ultimate goal of the Findable, Accessible, Interoperable, and Reusable (FAIR) principles. Community data or metadata standards are increasingly created through an approach that emphasizes collaboration between various stakeholders. Such an approach requires platforms for collaboration on the development process that centers on sharing information and receiving feedback. Our objective in this study was to conduct a systematic review to identify data standards and reporting formats that use version control for developing data standards and to summarize common practices, particularly in earth and environmental sciences. Of 108 data standardsmore »« less
A Guide to Using GitHub for Developing and Versioning Data Standards and Reporting Formats

Journal Article Crystal‐Ornelas, Robert ; Varadharajan, Charuleka ; Bond‐Lamberty, Ben ; ... - Earth and Space Science

Abstract Data standardization combined with descriptive metadata facilitate data reuse, which is the ultimate goal of the Findable, Accessible, Interoperable, and Reusable (FAIR) principles. Community data or metadata standards are increasingly created through an approach that emphasizes collaboration between various stakeholders. Such an approach requires platforms for collaboration on the development process that centers on sharing information and receiving feedback. Our objective in this study was to conduct a systematic review to identify data standards and reporting formats that use version control for developing data standards and to summarize common practices, particularly in earth and environmental sciences. Out of 108more »« less

Similar Records