This document is work in progress. If you experience any inconsistencies, have questions or would like to suggest additions, please feel free to contact us or open an issue in our Helpdesk.
We are very happy that you chose our tools and infrastructure to create and share your own ARCs. In this QuickStart we assume that your ARC already contains one or more isa.study.xlsx and isa.assay.xlsx file(s), respectively. Use the isa.study.xlsx to describe the characteristics of your samples, e.g. how you grew your plant, and isa.assay.xlsx to annotate the experimental analyses. In the following we will focus on adding metadata to your studies and assays with our excel tool Swate.
DataPLANT provides the Excel Add-In Swate to support you in data annotation.
Download and install the newest Swate version according to these instructions.
In case you use an Excel version older than Excel 2019, please install Swate for Excel online.
Use the create annotation table button in the yellow pop-up box (this only appears if you start Swate on an Excel worksheet without an existing annotation table). An annotation table with the building blocks Source Name and Sample Name will be generated.
Annotate your table with help of the annotation principles.
The combination of ISA (Characteristics, Parameter, Factor) 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 (Parameter [temperature] or Factor [temperature]).
Choose the type of building block you want to add (A).
If you chose a descriptive building block type (building blocks besides Sample Name, Source Name, and Data File Name), use search field (B) to search for an Ontology Term. Swate accesses the SwateDB with a list of established external ontologies designated suitable for use in plant science. In addition, we feature our own ontology NFDI4PSO to extend the DB with missing, but necessary terms.
If you want to add a building block with a unit, check box (C) and use search field (D) to look for a fitting unit term, e.g. degree Celsius as unit for Parameter [temperature].
If you could not find a fitting term, you can use the Advanced Term Search with the blue links above the Add building block button. If you still could not find a fitting term, use free text input.
Alternatively, you can also use one of DataPLANT’s Swate templates. You can find them under the Protocol Insert tab in Swate.
Fill the cells beneath each building block with ontology terms to note the respective Characteristics, Parameter, and Factor values of your experiment. Using the ontology term search function, you can fill multiple cells at once.
When Use related term directed search (A) is enabled, Swate will suggest a selection of suitable terms within the ontology for the column header, e.g. TripleTOF 5600 for instrument model.
When term directed search (A) is disabled, Swate will still suggest ontology terms, but without relation to the column header.
If you could not find a fitting term, use free text input.
Note: More information on how to use Swate can be found here.