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

Swate Templates - Contribution Guide

last updated at 2023-04-18

💡 This walk-through tutorial is meant for data stewards and data managers


Before contributing Swate templates you ideally have

💡 Feel free to contact us for Data Steward support, if you are not familiar to GitHub or Swate, but would like to contribute a Swate template for your community

Git Workflow to add or edit templates
  1. Fork the Swate-templates repository.
  2. (Recommended) Create an issue with background information about the template you want to add. This also serves as a place for discussion.
  3. (Recommended) Create a feature branch on your fork.
  4. Clone your fork-branch
  5. Add/update ONE template (see steps below)
  6. Commit, push and sync your branch.
  7. Open a pull request

    👀 You can reference your issue typing # in the pull request's commenting dialog

Creating a new Swate template Create a new Annotation Table in a fresh Excel workbook
  • Open a new Excel workbook <template>.xlsx

  • Create an Annotation Table

  • Save the Excel file in a suitable folder within your local clone of the Swate templates repository

    • 💡 check the subfolder`s
    • 🚧 naming convention for files and directories is work in progress
  • Add building blocks to your template's Annotation Table

Local clone of Swate templates repository (April 19, 2023)
Recommendations for template design Add Template Metadata

⚠️ Make sure to never change any of the fields in the first column. These "key" fields must exist to create a functional template. Always only change the "value" fields (second and following columns).

Template Metadata Explanation
Key Definition Tip 💡
Id Do not change this field. It maps your template to a database entry ⚠️
Name This is the first info Swate users see about your template Try using a short, descriptive and human readable name. (Think YouTube video title)
Version The version of the template following the SemVer convention. For a new template use 1.0.0. Raise the version number when updating an existing template
Description Here you can describe your template Users interested in your template can read this in Swate, but not search by it
Organisation The name of an organisation or community you create this template for. This facilitates searching for relevant templates in a specific organisation or community. Templates with the organisation "DataPLANT" are listed as curated in the Swate template database. All other templates are listed as community.
Table This value must match the name of the annotation table you want to use as a template To find the name click on any field in your annotation table, then open the Table Design (on macOS: Table) tab. Copy the name to the "Table" value field
ER list You can add any number of endpoint repositories to which your template complies here You may want to add them as ontology terms with unique identifier and source
TAGS list You can add any number of tags here. These tags are the basis to search for your template You may want to add them as ontology terms with unique identifier and source
AUTHORS list Add your name/alias here with as much information as you like.
Template Metadata Example

Here is an example for filled out template metadata and how it helps in Swate's template search.

Your template is ready for upload 🎉 Recommended best practices Known pitfalls with Swate Templates

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 .
✏️ Edit this page