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

split 2 pages

parent 47f443b8
No related branches found
No related tags found
1 merge request!159Refactor Help pages
Pipeline #118771 passed
---
title: DefenseFinder Webservice
layout: article
---
# Documentation
## DefenseFinder
[DefenseFinder](https://github.com/mdmparis/defense-finder) is a software to detect defense systems in bacterial genomes.
It takes as input a fasta file, be it nucleic or protein (it will guess which).
On the web service page, users can upload (1) their fasta file(s). One can upload multiple fasta files at once, as many jobs will run.
Job are automatically launched once the upload is done. Jobs can be found in the analysis panel (2), and are named with the name of the input file. The job name can be changed.
Analyses are kept for 6 months, or with a maximum of 10 jobs.
![webservice_interface](/help/webservice_interface.jpg){max-width=750px}
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.
--- ---
title: Help title: Contributing to the Wiki
layout: article layout: article
navigation: navigation:
icon: 'md:help'
--- ---
# Documentation # Contributing to the Wiki
## DefenseFinder ## 1/ Create an account
[DefenseFinder](https://github.com/mdmparis/defense-finder) 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 (1) their fasta file. One can upload multiple fasta files at once, as many jobs will be run.
Users need to provide a name for the job (2) being submitted before clicking on the submit button (3).
Once a job is submitted, the page is redirected to the "Analyses" panel (4) where results of the past runs can be found.
![webservice_interface](/help/webservice_interface.jpg){max-width=750px}
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
### 1/ 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. 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.
...@@ -43,7 +22,7 @@ Once your account is created, you need to request access to the project, on the ...@@ -43,7 +22,7 @@ Once your account is created, you need to request access to the project, on the
Click, and wait for an admin approval. Click, and wait for an admin approval.
### 2/ Edit a page ## 2/ Edit a page
Once you have access to the project (the previous step is done once), you can edit easily each page of the wiki, and post [issues](https://gitlab.pasteur.fr/mdm-lab/wiki/-/issues) (if you have question about something or remarks with anything from content to design). Once you have access to the project (the previous step is done once), you can edit easily each page of the wiki, and post [issues](https://gitlab.pasteur.fr/mdm-lab/wiki/-/issues) (if you have question about something or remarks with anything from content to design).
...@@ -65,7 +44,7 @@ To do so, just fill in the description (1) of what you did, or anything that you ...@@ -65,7 +44,7 @@ To do so, just fill in the description (1) of what you did, or anything that you
![Create MR](/help/Create_MR.png){max-width=750px} ![Create MR](/help/Create_MR.png){max-width=750px}
### 3/ Tips to write Markdown ## 3/ Tips to write Markdown
As a general advice, check an already written file to see how other pages are written.<br><br> As a general advice, check an already written file to see how other pages are written.<br><br>
......
navigation.icon: "md:help"
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