Skip to content
Snippets Groups Projects
Commit 7da890e9 authored by Jean c's avatar Jean c
Browse files

start to work on Help page

parent fdbf6b59
No related branches found
No related tags found
1 merge request!16start to work on Help page
Pipeline #112850 failed
--- ---
title: help title: Help
layout: article layout: article
navigation: navigation:
icon: 'md:help' icon: 'md:help'
...@@ -7,5 +7,35 @@ navigation: ...@@ -7,5 +7,35 @@ navigation:
## test
de l'aide # Documentation
\ No newline at end of file
## DefenseFinder
DefenseFinder is a software to detect defense systems from bacterial genomes.
It takes as input a fasta file, nucleic or proteic (it will guess which).
On the web service page, users can upload their fasta file. A user can upload multiple fasta files at once.
Users need to provide a name for the job being submitted before clicking on the submit button.
Once a job is submitted, the page is redirected to the Analyses panel where results of the past runs can be found.
![webservice_interface](/public/help/webservice_interface.jpg)
The result consists in 3 tables :
- Systems table : One system per line. On the column type, there is the name of the system, and one can click on it to be redirected to the corresponding wiki page.
- Genes table : One gene per line. Those are genes from the aforementioned system, with some addition information on the quality of the hit. The key between both table is `sys_id`
- HMMER table : One gene per line. Here it's all the genes hit by a hmm profile, even when the gene is not part of a defense system.
## Contributing to the Wiki
### Create an account
The wiki is based on gitlab pages, and we are using the gitlab's instance of the Pasteur Institute. To contribute, users need to be part of the project.
On every page, there is a button at the bottom proposing to "Edit on Gitlab". It will allow anyone registered to edit a given page seamlessly.
But on the first try, the following dialog will be prompted. If you have a Pasteur account, chose 1, otherwise chose 2. In External account, you can connect with a third-party account such as Github, bitbucket or google.
If you have neither, register on Github first (it's always useful).
![Register](/public/help/register_1.png)
public/help/register_1.png

62.6 KiB

public/help/webservice_interface.jpg

62.8 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment