Skip to content

File name and folder structure

A clear and consistent naming convention and folder structure enhance the usability of your dataset. Follow these tips when preparing files:

  • File names:

Use clear, consistent, and descriptive file names. Include relevant details such as version numbers, dates, and data types. For example, name files like experiment_1_2025-01-01.csv for clarity and easy identification.

⚠️ Use only characters from the sets A-Z, a-z, 0-9, hyphen, or underscore. Avoid using special characters such as &% $ # : or )
  • Folder structure:

When uploading data to BSC Dataverse, you can organize files into one or more folders (directories) within a dataset. This allows for a more structured and logical presentation of your data. When the folder structure is defined, the Dataset Page will offer a switch between the traditional table view and the tree-like view that shows the folder and file hierarchy, making it easier to navigate your dataset.

Figure 1: Tree view of the folder structure in Dataverse

Tips for organizing your files:

  • Group files logically: Consider organizing your files by experiment, data type, or time period (e.g., raw_data/, processed_data/, scripts/).
  • Keep the structure simple: Avoid overly complex or deep nesting of folders. A simple hierarchy ensures easier navigation and access.
  • README files: Always include at least one README file in the main folder. This file should provide an overview of the dataset, how it’s structured, and any key information about the data. While a README for the main folder is mandatory, we also encourage adding README files to individual subfolders where necessary to explain the contents more clearly.

How to create the folder structure?

When you upload files, they will appear listed in the interface, as shown in Figure 2 (you can also access this table by selecting the uploaded files and navigating to Edit > Metadata).

Figure 2: File metadata view

Each file has a "File Path" field, which determines the folder structure. Here’s how it works:

  • In the first row (file3.pdf), the file is located in the "data" folder, which is a first-level folder from the root.

  • If the File Path is empty (e.g., third row, README.txt), the file remains in the root directory.

  • To create subfolders, refer to the second row (image1.png), where the file path is "data/image". This means image1.png is stored inside a second-level named "image", which is within the "data" folder.

See Figure 3 for the final folder structure representation.

Figure 3: Tree view of Figure 2