Create Metadata

Metadata is standardized information provided along with data that helps with data organization and description. We have tried to keep this to a minimum, but require the following depending on the data type. We provide templates to make the metadata creation process more straightforward and streamlined.

VEOIBD Metadata Dictionary

We encourage you to utilize our VEOIBD Metadata Dictionary to explore VEOIBD metadata terms by key, value, or descriptions and the interdependencies among keys.

Templates

There are two types of templates defined in the VEOIBD data model, metadata templates and file annotation templates; the latter defines metadata that is collected at the level of individual data files.

Metadata Templates

• Clinical Metadata Template defines an individual_id as is a unique identifier for each participant along with core demographic and clinically relevant details.

• Biospecimen Metadata Template defines a sample_id as is a unique identifier for each biospecimen along critical details about the biospecimen and links each sample_id to a individual_id defined by clinical metadata.

• Medication History Metadata Template expands on the clinical metadata by capturing information about medication history for study participants.

• Assay metadata templates capture critical, assay-specific metadata usually at the level of each sample that was processed for that assay. For example, bulk RNA-seq assay metadata would describe key information about each library that was generated and sequenced including information about the RNA sample quality.

File Annotation Templates

A file annotation template will be defined for each of the different levels of processing expected for each data type. These templates collect critical metadata about the data files such as equipment and software used, vendor kits, etc., as well as provide high level classifiers for organizing and describing these data files.

After data files are uploaded, the DCA can be used to generate a file annotation template with all of the files in a staging folder listed out, one per row.

How to Use the Template

Metadata templates will be interactive Excel files. It specifies information needs, visualizes interdependencies across columns, and applies basic data validation rules automatically.

• Hover over the header to see the definition of the column.

• The column shade indicates the requirement status.

  • Light blue is required

  • Light yellow is recommended

  • Non-highlighted is optional

  • Some columns are dependent on others, so filling in a specific value in one column may trigger additional required or recommended fields.

  • We highly recommend you provide information in both required and recommended columns. Metadata requirements may differ across data types or subgroups.

• Some columns in the template only allow values from a standardized set of options. You can select through the drop down menu or type the values into the cell. An alert box pops up if the provided value is invalid. Please refer to the VEOIBD Metadata Dictionary for detailed descriptions of the columns and valid values.