README.org 5.37 KB
Newer Older
1
#+TITLE: Vidjil -- High-throughput Analysis of V(D)J Immune Repertoire
2
#+AUTHOR: The Vidjil team (Mathieu, Mikaël, Aurélien, Florian, Marc, Ryan and Tatiana)
3

4
[[https://travis-ci.org/vidjil/vidjil][https://img.shields.io/travis/vidjil/vidjil/master.svg]]
Mathieu Giraud's avatar
Mathieu Giraud committed
5
[[http://opensource.org/licenses/GPL-3.0][http://img.shields.io/badge/license-GPLv3+-green.svg]]
6 7
[[https://landscape.io/github/vidjil/vidjil][https://landscape.io/github/vidjil/vidjil/master/landscape.svg?style=flat]]
# https://coveralls.io/r/vidjil/vidjil http://img.shields.io/coveralls/vidjil/vidjil.svg
8

9
# Vidjil -- V(D)J recombinations analysis -- [[http://www.vidjil.org]]
Mathieu Giraud's avatar
Mathieu Giraud committed
10
# Copyright (C) 2011-2018 by Bonsai bioinformatics at CRIStAL (UMR CNRS 9189, Université Lille) and Inria Lille
11 12 13 14 15 16 17 18 19
# [[contact@vidjil.org]]

V(D)J recombinations in lymphocytes are essential for immunological
diversity. They are also useful markers of pathologies, and in
leukemia, are used to quantify the minimal residual disease during
patient follow-up.
High-throughput sequencing (NGS/HTS) now enables the deep sequencing 
of a lymphoid population with dedicated [[http://omictools.com/rep-seq-c424-p1.html][Rep-Seq]] methods and softwares.

Mathieu Giraud's avatar
Mathieu Giraud committed
20 21 22
The Vidjil platform contains three components. 
Vidjil-algo processes high-througput sequencing data to *extract V(D)J
junctions and gather them into clones*. Vidjil-algo starts 
23 24
from a set of reads and detects "windows" overlapping the actual CDR3.
This is based on an fast and reliable seed-based heuristic and allows
25 26 27
to output all sequenced clones. The analysis is extremely fast
because, in the first phase, no alignment is performed with database
germline sequences. 
28

29
The Vidjil *web application* is made for the interactive visualization and
30
analysis of clones and their tracking along the time in a MRD setup or
31 32 33
in a immunological study. The web application can visualize data processed by
the Vidjil algorithm or by other V(D)J analysis pipelines, and
enables to explore further cluterings proposed
34
by software and/or done manually done by the user.
35 36 37 38 39
The web application can be linked to a *sample, experiment and patient database*
able to store sequencing data and metadata, to run RepSeq software
and to save annotations directly from the web application, with authentication.
Clinicians or researchers in immunology or hematology
can manage, upload, analyze and annotate their runs directly on the web applicaiton.
40 41 42

* Vidjil components

Mathieu Giraud's avatar
Mathieu Giraud committed
43
** Vidjil-algo
44

45
- Stable releases can be downloaded from http://bioinfo.lille.inria.fr/vidjil
46
- Development code is under [[algo/]]
47
- Documentation, compilation and installation instructions: [[doc/algo.org]]
48

49
** The web application
50

51
- Access at https://app.vidjil.org/ (demo login: demo@vidjil.org, password: vidjil)
52
- Please contact us if you would like to test your data and have a full account on the web server
53 54
- Development code is under [[browser/]] and [[server/]] (a =make= in those directories
  will get the necessary files)
55
- Documentation is in [[doc/]], it is also available from [[http://www.vidjil.org/doc]]
56 57 58 59

* Code and license

Vidjil is open-source, released under GNU GPLv3 license. 
Mathieu Giraud's avatar
Mathieu Giraud committed
60 61 62 63
You are welcome to redistribute it under [[http://git.vidjil.org/blob/master/doc/LICENSE][certain conditions]]. 
This software is for research use only and comes with no warranty.

The development code is available on [[http://git.vidjil.org/]].
64 65
Bug reports, issues and patches are welcome.

66 67 68 69 70
* Donations

We welcome Bitcoin donations to [[bitcoin:13u12m6LxVhesKEpS6T5wpYN19LHpwk8xt][13u12m6LxVhesKEpS6T5wpYN19LHpwk8xt]].
Thank you for your support !

71 72
* The Vidjil team

Mathieu Giraud's avatar
Mathieu Giraud committed
73
Vidjil is developed by Aurélien Béliard, [[http://cristal.univ-lille.fr/~giraud][Mathieu Giraud]], Ryan Herbert, Tatiana Rocher and [[http://cristal.univ-lille.fr/~salson][Mikaël Salson]]
74
from the [[http://cristal.univ-lille.fr/bonsai][Bonsai bioinformatics team]] (CRIStAL, CNRS, U. Lille, Inria Lille).
Mikaël Salson's avatar
Mikaël Salson committed
75 76
Vidjil is also developed by external colleagues:
Marc Duez located in Bristol (School of Social and Community Medicine, University of Bristol)
Mathieu Giraud's avatar
Mathieu Giraud committed
77
and Florian Thonier located in Rennes (department of hematology)
78 79 80 81
Vidjil is developed in collaboration with 
the [[http://biologiepathologie.chru-lille.fr/organisation-fbp/91210.html][department of Hematology]] of CHRU Lille, 
the [[http://www.ircl.org/plate-forme-genomique.html][Functional and Structural Genomic Platform]] (U. Lille 2, IFR-114, IRCL), 
and the [[http://www.euroclonality.org/][EuroClonality-NGS]] working group.
Mathieu Giraud's avatar
Mathieu Giraud committed
82 83
The research is supported by SIRIC ONCOLille (Grant INCa-DGOS-Inserm 6041), by Région Nord-Pas-de-Calais/Hauts-de-France (ABILES),
by Inria and by InCA.
84

Mikaël Salson's avatar
Mikaël Salson committed
85
* References
86

87 88 89
If you use Vidjil for your research, please cite the following references:

Marc Duez et al.,
90
“Vidjil: A web platform for analysis of high-throughput repertoire sequencing”,
91 92
PLOS ONE 2016, 11(11):e0166126
http://dx.doi.org/10.1371/journal.pone.0166126
93 94 95 96 97 98

Mathieu Giraud, Mikaël Salson, et al.,
“Fast multiclonal clusterization of V(D)J recombinations from high-throughput sequencing”,
BMC Genomics 2014, 15:409 
[[http://dx.doi.org/10.1186/1471-2164-15-409]]

Mikaël Salson's avatar
Mikaël Salson committed
99 100 101 102 103 104 105
You may also be interested in the following publication for the diagnosis of
acute lymphoblastic leukemia with high-throughput sequencing:

Yann Ferret, Aurélie Caillault, et al., “Multi-loci diagnosis of acute
lymphoblastic leukaemia with high-throughput sequencing and bioinformatics
analysis”, British Journal of Haematology 2016
http://dx.doi.org/10.1111/bjh.13981