Skip to content
Snippets Groups Projects
Commit 14598c75 authored by christine.tranchant_ird.fr's avatar christine.tranchant_ird.fr
Browse files

Updating description

parent 211af81b
No related branches found
No related tags found
No related merge requests found
......@@ -3,32 +3,6 @@ simplify the construction of a panreference using the map-then-assembly
approach. It consists in a Jupyter Notebook application that centralizes
code,documentation and interactive visualizations together
### Requirements
- Docker : https://docs.docker.com/get-docker/
- Python3 (v3.9.7) : https://www.python.org/
- biopython : https://biopython.org/
- panel : https://panel.holoviz.org/
- abyss : https://github.com/bcgsc/abyss/blob/master/README.md
- bwa (v. 0.7.17) : https://github.com/lh3/bwa/blob/master/README.md
- ea-utils (fastq-stats, v 1.01) :
https://expressionanalysis.github.io/ea-utils/
- samtools (v1.10) : http://www.htslib.org/
- assembly-stats : https://github.com/sanger-pathogens/assembly-stats
- cd-hit : https://github.com/weizhongli/cdhit/blob/master/README
- mnimap2
- girafe
How to use FrangiPANe ?
=======================
......@@ -54,6 +28,14 @@ Run FrangiPANe
wget https://itrop.ird.fr/frangiPANe/data_test.tar.gz
tar zxvf data_test.tar.gz
Previous version
For version 2.0:
Sebastien Ravel and Christine Tranchant-Dubreuil (2024).
For version 0.1:
Christine Tranchant-Dubreuil and al. (2023). FrangiPANe, a tool for creating a panreference using left behind reads. NAR Genom Bioinform. doi: 10.1093/nargab/lqad013.
Licence
=======
......
......@@ -15,6 +15,8 @@ __doc__ = """frangiPANe was developed as a modular and interactive application t
using the map-then-assembly approach. It consists in a Jupyter Notebook application that centralizes code,documentation and interactive visualizations together"""
description_tools = f"""
ad88 88 88888888ba db 888b 88
d8' '' 88 "8b d88b 8888b 88
......@@ -31,13 +33,14 @@ A modular and interactive application to simplify the construction of a panrefe
Version {__version__}
@author: Sebastien Ravel (CIRAD) and Christine Tranchant (IRD)
@author: Sebastien Ravel and Christine Tranchant
@email: christine.tranchant@ird.fr
Please cite our github: GIT_URL
Licencied under CeCill-C (http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html)
and GPLv3 Intellectual property belongs to IRD and authors.
and GPLv3 Intellectual property belongs to IRD, CIRAD and authors.
Documentation avail at: DOCS
"""
......
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