Skip to Content

6.6 Dataset Versioning

Last modified by publicadmin on 2025/12/16 13:04

About Dataset Versioning

Changes made to a Dataset are tracked in real time and can be viewed at any time in the Dataset Provenance Activity Stream.  From time to time, however, you may want to save a snapshot of your Dataset in its current state to be able to refer back to in the future or to make it available for other researchers to reference and use for their own analyses. 

The Dataset Versioning feature allows you to create a snapshot of your Dataset at a specific point in time.  When a new Dataset version is released, the data files and folders and the annotations stored in its metadata schemas are bundled together and saved.  The version is now locked so that no additional changes can be made.  This version can be downloaded as a zip file from the Dataset Explorer.  

How to release a new Dataset Version

  1. Open the Datasets feature from the top VRE menu bar, then navigate to your Dataset.
  2. After making any desired updates to the Dataset, click Release new version.
  3. Select Minor or Major Release.  The version numbering applied automatically based on the last Version you published, starting with Version 1.0.  The distinction of Minor vs. Major is entirely at your discretion.
  4. Enter a brief description of this Dataset release in the Version Notes box.  A high-level summary of the changes made to the Dataset since the last release is recommended.
  5. Click Publish Version.

How to download a Dataset Version

  1. Open the Datasets feature from the top VRE menu bar, then navigate to your Dataset.
  2. Click Versions in the top left corner of the Dataset Canvas.  A list of the previous versions will appear in the right-side panel.
  3. Click the Download icon next to the version you wish to download.  A .zip archive will be generated that contains:
    • all the files and folders in Dataset Version in their original folder hierarchies
    • all the metadata annotations added to the Dataset at the time the Version was created
Warning

NOTE: When you use the Download function, the data leaves the VRE and will be stored on your local computer.  For Datasets that contain personal data governed by GDPR, it is the Data Controller's responsibility to ensure that this action is consistent with the data processing activities stated in your project's Data Protection Impact Assessment.

See Also: 

Dataset Organization and Validation

Dataset Provenance

https://i.creativecommons.org/l/by-sa/4.0/88x31.png

Copyright © 2022, Indoc Research. This work is licensed under a Creative Commons Attribution-ShareAlike 4.0  International License.