Documenter germline/homo-sapiens.g et les méthodes de recombinaison (#2920) · Issues · vidjil / vidjil

Documenter germline/homo-sapiens.g et les méthodes de recombinaison

En faisant !75 (merged)/!76 (merged), je me rends compte que ni doc/vidjil-algo.md, ni doc/locus.md ne détaillent la syntaxe de homo-sapiens.g.

Derrière les questions de syntaxe, il y a aussi les questions de méthodes de recombinaison... qui ne sont tout simplement pas expliquées. Même si on peut renvoyer aux papiers, la doc doit fournir quelques éléments d'explications.

la différence entre 53 et 543 peut sembler triviale, mais autant le dire.
MAX12 est évoquées cryptiquement dans vidjil-algo.md, c'est un peu mieux dans locus.md... alprs que c'est une option quasi "par défaut"
MAX1U n'est pas évoqué (mais pas utilisé / à retester ?)
et la nouvelle ONE #1724 (et d'ailleurs, trouver mieux que 31581d71 ?)

====

From duplicate #4012 (closed):

vidjil-algo is able to handle different germlines, either from IMGT/GENE-DB, or for other sources. Beyond the -V / -D/-Joptions, the.g` file is very flexible. However (Zhang, 2019) reports that "more effort should be made to manage customization" vdj#919.

We should ensure that this is properly documented. What is the syntax of the .g file, and what are the recommended steps for anyone wishing to better use a custom germline ?

En faisant !75/!76, je me rends compte que ni `doc/vidjil-algo.md`, ni `doc/locus.md` ne détaillent la syntaxe de `homo-sapiens.g`.

Derrière les questions de syntaxe, il y a aussi les questions de méthodes de recombinaison... qui ne sont tout simplement pas expliquées. Même si on peut renvoyer aux papiers, la ~doc doit fournir quelques éléments d'explications.
  - la différence entre `53` et `543` peut sembler triviale, mais autant le dire.
  - `MAX12` est évoquées cryptiquement dans `vidjil-algo.md`, c'est un peu mieux dans `locus.md`... alprs que c'est une option quasi "par défaut"
  - `MAX1U` n'est pas évoqué (mais pas utilisé / à retester ?)
  - et la nouvelle ONE #1724 (et d'ailleurs, trouver mieux que 31581d712d ?)

====

From duplicate #4012:

vidjil-algo is able to handle different germlines, either from IMGT/GENE-DB, or for other sources. Beyond the `-V / `-D`/`-J`options, the`.g\` file is very flexible. However (Zhang, 2019) reports that "more effort should be made to manage customization" vdj#919.

We should ensure that this is properly documented. What is the syntax of the `.g` file, and what are the recommended steps for anyone wishing to better use a custom germline ?

Edited Aug 27, 2020 by Mathieu Giraud

To upload designs, you'll need to enable LFS. More information