Skip to content

Data description

When uploading data to BSC Dataverse, it's essential to provide a comprehensive description to ensure that other researchers can interpret, understand, and reuse your data effectively. The data description can include various types of metadata and documentation that improve the clarity and accessibility of your dataset.

Therefore, a README file is is mandatory in each BSC Dataverse dataset.

A README file is a detailed user guide for your dataset that explains how the dataset was created, its completeness, and any potential restrictions, and it should – at least – contain the following information:

  • Title of the dataset and contact information
  • Methods used in data collection or analysis
  • Data and file overview: brief descriptions of each data file
  • Data-specific information: details on the structure and variables
  • Terms of Reuse: any licensing or restrictions for using the data

The README file should be in plain text format with Unicode UTF-8 encoding (.txt). If you need to include illustrations or specific formatting, you may save your README file as PDF/A.

You can find below a template for the README file provided by CSUC (here):