Tool tutorial

Purpose : explain how to add new bioinformatics tool on the IFB catalogue.

A few word about bio.tools

We use the bio.tools API to scrape some data. All tools you register in the IFB Catalogue will need first to be registered in the bio.tools registry. Detailed documentation regarding the registration of software in bio.tools is available here, including a Quickstart section and a (maybe slightly outdated) IFB-specific section.

The functional description of the tools relies mostly on the EDAM ontology. Practically speaking, this means that you need to browse EDAM to find the terms you need. To browse EDAM easily, we highly recommend the use of EDAM browser.

Once you have found or created the tool(s) you'd like to add to the Catalogue in bio.tools, you're ready to move to the Catalogue.

Preconditions

Ensure that you have followed these steps :

1. Connecting to your account
2. Access to admin dashboard
3. Make sure your have privileges to perform CRUD operations

Adding tools

For that, ensure that you know the biotoolsID of your tool and follow these steps :

1. From admin dashboard, find tool menu and click on it

Or just open this link in another tab of your browser

2. Click on Add tool button, and type your biotoolID (without any space after or before the name) as you see in the screenshot below :

Note that if you try to fill a biotoolID which is already in catalogue DB, the system will raise an error.

3. Click on Save button and the system will scrapes data from biotool api.

It is possible that after saving, you do not get any informations for your tool. That means two things :

• Your tool is not in biotool platform
• You made some mistakes when you fill your biotoolID

Update tools

If you made some change on your tool from biotool and you do not see these changements from catalogue, follow these steps :

1. Find out your tool in catalogue and select it
2. On the top of tool lists, you can see a dropdown menu
3. Select Update information from biotool and click on Go button

This action aims to connect to Biotool to retrieve informations on your tool and load them into the catalogue DB