Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "releaseNotes" Property to BioSchemas for Dataset Versioning #704

Open
zaesa opened this issue Mar 1, 2025 · 0 comments
Open

Add "releaseNotes" Property to BioSchemas for Dataset Versioning #704

zaesa opened this issue Mar 1, 2025 · 0 comments

Comments

@zaesa
Copy link

zaesa commented Mar 1, 2025

Problem Statement:
There is currently no standardized property to document changes between versions of datasets, such as corrections, additions, or deletions in Bioschemas for datasets. Without a dedicated property like releaseNotes, it is challenging to track changes between dataset versions. This makes it difficult for users to understand what has been updated, corrected, or removed.
In scientific research, transparency about dataset updates is crucial for reproducibility and trustworthiness.

Proposed Solution:
Add a "releaseNotes" property to BioSchemas profiles, particularly for datasets, similar to the property "releaseNotes" of SoftwareApplication (text or URL). This property would allow dataset maintainers to document changes, corrections, additions, or deletions made in each version.

Use Cases:

  • Documenting error corrections.
  • Noting the addition or removal of cases (e.g., samples, observations).
  • Highlighting changes in data processing or analysis methods.

Benefits:

  • Improved Transparency: Enhances dataset credibility by providing clear information about changes.
  • Facilitates Reproducibility: Helps researchers understand how dataset updates might affect their analyses.
  • Simplifies Version Management: Makes it easier for users to manage different versions of datasets.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant