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 Electronic Lab Notebooks (ELN) DataPLANT Implementations Annotated Research Context User Journey ARC specification ARC Commander QuickStart QuickStart (Experts) Swate QuickStart Walk-through Best Practices For Data Annotation DataHUB DataPLAN Ontology Service Landscape ARC Commander Manual Setup Git Installation ARC Commander Installation Windows MacOS Linux ARC Commander 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 Installation - Linux QuickStart ARCmanager Manual What is the ARCmanager? How to use the ARCmanager Swate Manual Swate Installation Excel Browser Excel Desktop Windows – installer Windows – manually macOS – manually 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 File Picker Expert Features Contribute Templates ISA-JSON Workflows Manual CWL Introduction CWL runner installation CWL Examples CWL Metadata 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) ARCitect QuickStart 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 DataPLANT account Invite collaborators to your ARC Work with your ARC Using ARCs with Galaxy Recommended ARC practices Syncing recommendation Keep files from syncing to the DataHUB Working with large data files Adding external data to the ARC ARCs in Enabling Platforms Publication to ARC Contribute Swate Templates Knowledge Base Teaching Materials Slides DataPLANT Annotated Research Context Videos Start Your ARC Series Events 2023 Nov: CEPLAS PhD Module Oct: CSCS CEPLAS Start Your ARC Sept: MibiNet CEPLAS Start Your ARC July: RPTU Summer School on RDM July: Data Steward Circle May: CEPLAS Start Your ARC Series Frequently Asked Questions

Swate Templates Contribution Guide

last updated at 2023-08-14 About this guide

This tutorial guides you how to create and share Swate metadata templates.

UserData Steward ModeTutorial

Before we can start

Before contributing Swate templates you ideally have

Git Workflow to add or edit templates
  1. (Recommended) Create an issue with background information about the template you want to add. This also serves as a place for discussion.
  2. Fork the Swate-templates repository.
  3. (Recommended) Create a feature branch (e.g. "template-xy") 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 README.md`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 .
Contribution Guide 📖
✏️ Edit this page