Custom database - metaspace2020/metaspace GitHub Wiki

How to Add a Custom Database in TSV Format

Introduction

Tab-separated values (TSV) files are used for storing data in a tabular structure. This guide will help you format and upload your custom database in TSV format.

Step-by-Step Guide

Understanding TSV Format

A TSV file is a text file with each field separated by a tab and each record on a new line. The first line contains the field headers 'id', 'name', and 'formula'.

Prepare Your Data

Organize your data in a spreadsheet with columns for each attribute, such as 'id', 'name', and 'formula'.

Create TSV File

  • In your spreadsheet, go to '''File > Save As'''.
  • Select 'Text (Tab delimited) (*.tsv)' in the 'Save as type' dropdown.
  • Name your file and click '''Save'''.
  • Accept any prompts about feature compatibility.

Verify the Format

You can open your TSV file in a text editor to confirm the correct tab separation.

Upload Your Database

  • Navigate to the system's upload section.
  • Drag and drop your TSV file or click to browse and select it.
  • Enter any additional information like 'Name' or 'Version'.

Submit the Database

  • Review your information.
  • Click '''Continue'''
  • Wait for the system to process your file.

Example TSV Content

id name formula
HMDB0000122 Glucose C6H12O6
HMDB0000169 Mannose C6H12O6
HMDB0000094 Citric acid C6H8O7

Troubleshooting

  • Check for extra spaces, missing tabs, or incorrect line breaks if the upload fails.
  • Ensure data matches the system's expected format.

Conclusion

Please follow these steps to successfully create and upload a TSV file for your custom database, following platform-specific requirements.

⚠️ **GitHub.com Fallback** ⚠️