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 MetadataQuiz 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 QuickStart - Videos ARCmanager Manual What is the ARCmanager? How to use the ARCmanager Swate Manual QuickStart - Videos Annotation tables Building blocks Building Block Types Adding a Building Block Filling cells with ontology terms Advanced Term Search File Picker Templates Contribute Templates 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 CQC Pipelines & validation Find and use ARC validation packages 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 Sharing ARCs via the DataHUB Work with your ARC Using ARCs with Galaxy Computational Workflows CWL Introduction CWL runner installation CWL Examples CWL Metadata 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 Troubleshooting Git Troubleshooting Contribute Swate Templates Knowledge Base Teaching Materials 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 Start Your ARC Series - Videos Events 2024 TRR175 Becoming FAIR CEPLAS ARC Trainings – Spring 2024 MibiNet CEPLAS DataPLANT Tool-Workshops TRR175 Tutzing Retreat Frequently Asked Questions

Swate Templates Contribution Guide

last updated at 2024-03-22 About this guide

This tutorial guides you how to create Swate metadata templates with Swate-alpha.

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 or open a Swate template

Open Swate-alpha. To create a new template click "New File" and select "Template". If you want to edit an existing template, click "Import" and select the respective file.



Add Template Metadata

Once you open a new template, you will see a "Metadata" sheet. Here you will enter a name for the template as well as further information describing the template. You can find explanations of the necessary information in the table below.

Template Metadata Explanation
Key Definition Tip 💡
Identifier 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. Capitalize the first letter of the first word.
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.
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.
Tags You can add any number of tags here. These tags are the basis to search for your template. If possible add them as ontology terms with source ontology (TSR) and unique identifier (TAN). If similar tags already exist, consider reusing the existing ones.
Endpoint Repositories If your template complies with the requirements of an endpoint repository, you can add the respective repository here. You may want to add them as ontology terms with source (TSR) and identifier (TAN).
Authors 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.

img1

Add building blocks

To add the building blocks of your actual template, you need to switch from the "Metadata" sheet to the "New Table" sheet on the bottom left. Using the "Add Building Block" button, you can add your desired building blocks with or without a unit.



Recommendations for template design Recommendations for adding endpoint repository templates Save your template

Save your template by clicking on the disc symbol in the top right corner. This will download an xlsx-file. Please adjust the name of the file to correspond to the name of the template, but use underscores instead of spaces. Save the file in a suitable folder within your local clone of the Swate templates repository.

Your template is ready for upload 🎉 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