Contribute: How to add to and edit tools and resources

The tools and resources table is automatically created from the yaml file: _data/tool_and_resource_list.yml. This file should not be edited directly. To add to or edit the information in the table, please add to or edit the information in the Field Guide Tools and Resources google sheet which is located within the BioCommons Human Data Google folder under Activities/Human Omics Data Sharing Field Guide. Each time the website is built, the script var/tools_table_converstion.py runs as part of the GitHub Actions that deploy the site, and converts the google sheet to the yaml file.

Editing the Google Sheet

Columns:

• name: This is the display name that will show up when a tool is tagged and in the table
• url: the full url of the resource (required)
• description: A brief description of what the tool or resource is
• id: kebab-case (lower case with hyphens) version of the tool name that is used for tagging
• fairsharing: The FairSharing identifier for the resource, if one exists
• biotools: The bio.tools identifier for the tool if one exists
• tess: The Training eSupport Systen (TeSS) identifier for the tool if one exists
• europmc: The Europe PMC identifier (PMID) for the most relevant publication for the tool or resource

Tagging a tool or resource

On any page where you want to refer to a resource

Add the tool in the text by mentioning it using following syntax:

{% tool "tool_id" %}

Example:

The following code snippet:

{% tool "beacon" %} is a GA4GH standard which enables standardised querying across multiple sources.

Will give:

Beacon v2 is a GA4GH standard which enables standardised querying across multiple sources.

When a tool is tagged on a page, a table containing all tools and resources mentioned on the page is added to the bottom of that page (see below).

Relevant tools and resources

Marion Shadbolt

Editor

Australian BioCommons / University of Melbourne