Home Fundamentals Research Data Management FAIR Data Principles Metadata Ontologies Data Sharing Data Publications Data Management Plan Version Control & Git Public Data Repositories Persistent Identifiers DataPLANT Implementations Annotated Research Context User Journey ARC Commander QuickStart QuickStart (Experts) Swate QuickStart Walk-through Best Practices For Data Annotation DataHUB DataPLAN ARC Commander Manual Setup Installing Dependencies Configure Git Installing the ARC Commander Windows MacOS Linux DataHUB Access Before we start Central Functions Initialize Clone Connect Synchronize Configure Branch ISA Metadata Functions ISA Metadata Investigation Study Assay Update Export ARCitect Manual Installation - Windows Installation - macOS Swate Manual Setup Installing Swate Browser Windows Desktop via installer (beta-stage) Windows Desktop manually (recommended) macOS Desktop manually (recommended) Organization-wide Core Features Annotation tables Building blocks Building Block Types Adding a Building Block Using Units with Building Blocks Filling cells with ontology terms Advanced Term Search Templates Contribute Templates File Picker Expert Features ISA-JSON DataHUB Manual Overview User Settings Generate a Personal Access Token (PAT) Projects Panel ARC Panel Forks Working with files ARC Settings ARC Wiki Groups Panel Create a new user group Data publications Passing Continuous Quality Control Submitting ARCs with ARChigator Track publication status Use your DOIs Guides ARC User Journey Create your ARC ARC Commander QuickStart ARC Commander QuickStart (Experts) Annotate Data in your ARC Annotation Principles ISA File Types Best Practices For Data Annotation Swate QuickStart Swate Walk-through Share your ARC Register at the DataHUB Invite collaborators to your ARC Recommended ARC practices Syncing recommendation Keep files from syncing to the DataHUB Working with large data files Adding external data to the ARC Contribute Swate Templates Knowledge Base Teaching Materials Slides DataPLANT Annotated Research Context Videos Start Your ARC Series Events CSCS CEPLAS Start Your ARC MibiNet CEPLAS Start Your ARC RPTU Summer School on RDM Data Steward Circle CEPLAS Start Your ARC Series Frequently Asked Questions


last updated at 2022-08-01

Swate (Swate workflow annotation tool for Excel) is one of two central DataPLANT tools designed for convenient interaction with your ARC (the other one being the ARC Commander). Swate simplifies adding standardized metadata for your experimental workflows by leveraging a simple use of ontologies.

Swate for ontology driven metadata annotation

A key factor in the development of research data management tools is finding the balance between standardization and the requirements of researchers for annotating their experimental workflows. The spreadsheet-based version of the well-established ISA framework allows for ontology-driven metadata annotation of these workflows in a simple and accessible way. However, finding the appropriate ontology term can be extremely tedious and often results in incomplete metadata annotation. To overcome this hurdle, DataPLANT offers SWATE to facilitate the generation of ISA-Tab annotation tables with an integrated search function and an ontology guided metadata annotation.

Fully integrated in Microsoft Excel (Excel online, Excel 365, and Excel 2019), Swate leverages standard spreadsheet features, such as color coding or highlighting (increasing user experience and acceptance) without polluting the actual metadata information. Users can add and delete building blocks to their ISA compliant annotation tables, describing the data in a clear representation. These building blocks can either represent a

Combination of ISA (Characteristic, Parameter, Factor, Component) and a biological or technological ontology (e.g. temperature, strain, instrument model) gives the flexibility to display an ontology term, e.g. temperature, as a regular process parameter or as the factor your study is based on within your annotation table (Parameter [temperature] or Factor [temperature]). For more information on these building blocks, please check our annotation principles.

Building Blocks

Ontology terms within the Swate database can not only be used to standardize the headers of your annotation table, but also for standardization of the respective values. When filling in metadata via the "related term directed search", Swate will suggest matching metadata terms for the respective building block within the database. Of course, users are not forced to use this feature in case they opt for more flexibility.


Templates for convenient metadata annotation

Metadata annotation as part of the data submission routine to public repositories is often bothersome due to a high variability between repository requirements. This can become particularly inconvenient when the same metadata is submitted repeatedly, e.g. to unrelated public repositories. To assist researchers in this process, DataPLANT provides a growing collection of templates as a starting point for their annotation tables. The template design process is initiated “backwards”, starting from the requirements of public repositories and thereby, compliance with metadata standards. Our Data stewards supervise the metadata harmonization between template and target repository and simultaneously contribute to the development of the DataPLANT broker ontology .
From a technical perspective, these templates are ISA Protocols containing various Characteristics, Parameters, and the Study specific Factor. DataPLANT provides checklists and requirements of public repositories as templates that are considered useful for various technologies and common standards, e.g. MIAPPE or MINSEQE. The templates can directly be integrated to the isa.study.xlsx and isa.assay.xlsx files using Swate. Once loaded into the table, they still can be modified to special needs in the sense of adding or deleting annotation building blocks. The modularity of the system also gives labs and institutions the possibility to create their own lab specific templates for experiments that are frequently run in the lab, e.g. a metabolomics experiment of a measurement facility. High flexibility is fostered by offering a manual or Swate-supported template customization, distribution, and use.


There is no wrong or right

Neither does DataPLANT tell you which building blocks or terms you should use for your data annotation, nor do we enforce the usage of our templates. These shall only serve as a starting point for your annotation table and CAN assist you during data submission to specific endpoint repositories.

If you cannot find a fitting term for your data annotation, you can try to use Swate's Advanced Term Search. If you still cannot find a fitting term, annotate your data with free-text. Any annotation will help to understand your data. Hence, an ontology-independent annotation is still preferred over a missing annotation. Feel free to contact us or open an issue in our Helpdesk if you want to request the addition of a term to our broker ontology.

What's next?

After reading this article, you should

DataPLANT Support

Besides these technical solutions, DataPLANT supports you with community-engaged data stewardship. For further assistance, feel free to reach out via our helpdesk or by contacting us directly .
Contribution Guide 📖
✏️ Edit this page