Fundamentals
Research Data Management
FAIR Data Principles
Metadata
Ontologies
Data Sharing
Data Publications
Data Management Plan
Version Control & Git
Public Data Repositories
Persistent Identifiers
Implementation within DataPLANT
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
Swate Manual
Setup
Installing Swate
Browser
Desktop, via installer (beta-stage)
Desktop, manually (recommended)
MacOS
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
Frequently Asked Questions
Teaching Materials
DataPLANT Overview
Big Picture
ARC structure
ARC Demo
last updated at 2022-09-19
Altough i will mostly talk about the Ontology term search on this page, it will also feature useful information about term search related to the Building Blocks page. Such general applicable information will be listed under General.
Ontologies are controlled vocabularies of Terms. Most of these Terms feature a name, a unique identifier and a description. We use these Ontology Terms for workflow description to utilize the benefits of a unified language in terms of machine-readability and reproducibility, following FAIR principles.
General
You can find ontology term search fields on the Building Blocks and on the Terms tab in the navbar.
Features:
- Access to the SwateDB with a list of established, external ontologies deemed fit for use in plant science. In addition we feature our very own ontology DPBO, which we extend with missing but necessary terms.
- Search through database with autocomplete search on term names.
- If you already know what you are searching for, you can also type in the term unique identifier (example:
MS:1000031
).
- To execute the search query on any search text again after closing the dropdown with the search results double click into the search field.
- You can also use the advanced term search for a more refined search approach. Just click on the blue link close to the related search field.
Term Insert
You can find this function on the Terms tab in the navbar. Use this function to insert terms in an ISA-Tab conform way, for example for Swate building blocks.
- Type in the search field to trigger the auto-complete function and find terms. Select the term you want or follow the information under General for more information.
- You can now insert the chosen term anywhere in Excel, not only inside of a Swate annotation table.
Terms will be added to all selected rows in the format:
| term name | term source ontology | purl.obolibrary.org link for term |
This always done for the next three Excel columns including the selected column.
- You can also click on the Copy to Clipboard-button next to the insert term-button. This will copy the term information (name, source ontology, purl link) to your clipboard and you can paste it into Excel with Ctrl + V. This will enable you to paste the information spread over three rows instead of columns. This works only for a single column.
Relationship-Directed Search
Relationship-Directed Search Theory
Ontology terms contain different types of relationships between each other. For example is_a
, part_of
, xref
relationships. Swate and the SwateDB utilize these relationships to provide the user with a predefined set of terms as most likely search requests.
Let's look at this with an example:
Source Name |
Component [instrument model] |
Term Source REF (MS:1000031) |
Term Accession Number (MS:1000031) |
Sample Name |
|
|
|
|
|
If a user wants to fill in Component [instrument model]
then they are most likely looking for the instrument model used in their experimental workflow. Here for example the instrument model series and the exact instrument models are connected to instrument model (MS:1000031)
via is_a
relationships.
Relationship-Directed Search Usage
- Choose any descriptive building block (all building blocks with 3 or more columns work, e.g.
Protocol Type
) and select any number of rows in the main column.
- Click in the ontology term search field under the Terms tab in the navbar.
- This will create an additional field in front of the search field with the column header term inside.
- For the example table under theory one would click in any row below
Parameter [instrument model]
and then after clicking into the searchfield, one should see instrument model
. In this case we call instrument model
the parent term and all related terms child terms.
- While the slider next to Use related term directed search is turned on, you will now ONLY search through related terms.
- 👀 You can also explore all available child terms, by double clicking into the empty search field.
- You can turn this feature off with the slider next to Use related term directed search.
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
.