chaoss / chaoss/wg-data-science

Publication Guidelines: Describe Data Sharing and Provenance

Open
#101 3 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Jupyter Notebook
Stars
30
Forks
26
Avg merge
14h 38m
Merged PRs (30d)
2

Description

I think the publication guidelines doc we just merged is fantastic! What I would like to see discussed/resolved in a future meeting are some guidelines around sharing of data, explaining the provenance of data used in reports, with particular attention to the steps from raw data through analysis. Where did we get the data? How? Was it verified/validated? How could another party explore the data.

Not sure if this is strictly necessary in every case, though I think credibility is greater to the extent these things are explained.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the recently merged publication guidelines document and the questions listed in this issue. Use a future working-group meeting to define whether data-sharing guidance is required and agree on coverage for data source, acquisition, validation, raw-to-analysis provenance, and how others can explore the data. Done means the agreed guidance is incorporated into the publication guidelines.

Written by the indexing model from the issue text.

Assessment

Domain
data, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.