Skip to content

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

@zaesa

Description

@zaesa

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions