vidjil issueshttps://gitlab.inria.fr/vidjil/vidjil/-/issues2018-07-10T11:34:20+02:00https://gitlab.inria.fr/vidjil/vidjil/-/issues/3005Génération doc html2018-07-10T11:34:20+02:00Mathieu GiraudGénération doc htmlLe `emacs -batch $^ -f "org-html-export-to-html"` n'a jamais fonctionné en batch chez moi (et comme certaines releases ont été faites en .tar.gz depuis chez moi, ce n'est pas sûr que tous les fichiers `html` étaient toujours à jour et/o...Le `emacs -batch $^ -f "org-html-export-to-html"` n'a jamais fonctionné en batch chez moi (et comme certaines releases ont été faites en .tar.gz depuis chez moi, ce n'est pas sûr que tous les fichiers `html` étaient toujours à jour et/ou aient été inclus dans les dernières releases).
Bref dans !97 c'est pour l'instant commenté... à voir si on le met ou pas. Les `.org` sont de toute façon bien présents. Tout cela sera probablement obsolète par #3004.Algo 2018.08https://gitlab.inria.fr/vidjil/vidjil/-/issues/3004Passer la doc en markdown2018-09-07T08:17:05+02:00Mathieu GiraudPasser la doc en markdownVoir comment conserver (ou même améliorer) l'export html. Ou bien voir directement si on passe à readthedocs ou autre chose ?
* [ ] ~~Adapter [org-babel-tangle.py](tools/org-babel-tangle.py) au Markdown~~ -> #3348
* [x] Utiliser un con...Voir comment conserver (ou même améliorer) l'export html. Ou bien voir directement si on passe à readthedocs ou autre chose ?
* [ ] ~~Adapter [org-babel-tangle.py](tools/org-babel-tangle.py) au Markdown~~ -> #3348
* [x] Utiliser un convertisseur Markdown → HTML pour la génération automatique des fichiers (cf. https://gitlab.inria.fr/vidjil/vidjil/issues/3004#note_78478) -> voir finalement 97890159Algo 2018.08https://gitlab.inria.fr/vidjil/vidjil/-/issues/3003Makefile et Makefile.algo, séquence de make2018-02-01T10:01:27+01:00Mathieu GiraudMakefile et Makefile.algo, séquence de makeEt retravailler si besoin les `Makefile`, et/ou en refaire un global, mais en sachant exactement ce qu'on met dedans, voir `release_check` dans fac04b1.
Voir #2255, #2999. Prépare aussi #1491.Et retravailler si besoin les `Makefile`, et/ou en refaire un global, mais en sachant exactement ce qu'on met dedans, voir `release_check` dans fac04b1.
Voir #2255, #2999. Prépare aussi #1491.Algo 2017.11Mathieu GiraudMathieu Giraudhttps://gitlab.inria.fr/vidjil/vidjil/-/issues/2982Shorter / shifted w: documenter (algo.org, user.org)2018-01-31T09:21:21+01:00Mathieu GiraudShorter / shifted w: documenter (algo.org, user.org)Suite à #2913/!141.Suite à #2913/!141.Algo 2017.11https://gitlab.inria.fr/vidjil/vidjil/-/issues/2954Mettre à jour la documentation Docker2018-10-16T11:11:38+02:00Mathieu GiraudMettre à jour la documentation DockerSuite à #2755, dans `doc/server.org`
- mentionner Docker Hub (y a-t-il d'ailleurs un endroit standard où on documente des Docks ?)
- vu tout ce qui a été fait pour %"prod-server-lil", mettre à jour s'il y a eu des changements
Tout sera...Suite à #2755, dans `doc/server.org`
- mentionner Docker Hub (y a-t-il d'ailleurs un endroit standard où on documente des Docks ?)
- vu tout ce qui a été fait pour %"prod-server-lil", mettre à jour s'il y a eu des changements
Tout sera alors prêt pour #2950 :-)Ryan HerbertRyan Herberthttps://gitlab.inria.fr/vidjil/vidjil/-/issues/2950Tester l'installation via Docker sur une machine personnelle2018-10-16T10:59:45+02:00Mathieu GiraudTester l'installation via Docker sur une machine personnelleCe serait bien que quelqu'un qui ne soit pas @RyanHerb suive ce qui est dans est `doc/server.org` #2755 pour arriver à une installation complète sur sa machine.
Ce serait bien que quelqu'un qui ne soit pas @RyanHerb suive ce qui est dans est `doc/server.org` #2755 pour arriver à une installation complète sur sa machine.
https://gitlab.inria.fr/vidjil/vidjil/-/issues/2920Documenter germline/homo-sapiens.g et les méthodes de recombinaison2020-09-22T10:49:35+02:00Mathieu GiraudDocumenter germline/homo-sapiens.g et les méthodes de recombinaisonEn 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 so...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 ?https://gitlab.inria.fr/vidjil/vidjil/-/issues/2889Bypass your cache2020-02-11T11:17:12+01:00Mathieu GiraudBypass your cacheOriginellement dans #2734 :
On doit souvent dire aux utilisateurs de recharger Vidjil. Une suggestion pour indiquer de recharger le cache :
"Note that you should fully reload Vidjil to take into account these changes. Usually `shift+F5...Originellement dans #2734 :
On doit souvent dire aux utilisateurs de recharger Vidjil. Une suggestion pour indiquer de recharger le cache :
"Note that you should fully reload Vidjil to take into account these changes. Usually `shift+F5` or `control+F5` works, see https://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache ."
Est-ce que cette phrase est bonne ?
Est-ce que ce type de phrase aurait aussi sa place quelque part dans la doc ?
(#2734 parle de comment réduire le besoin de ceci.)
cc @flothonihttps://gitlab.inria.fr/vidjil/vidjil/-/issues/2880Tester le tutorial + CI2021-02-11T08:00:05+01:00Mathieu GiraudTester le tutorial + CISi on était pervers du test, on pourrait mettre des commandes dans le tutorial pour lancer des tests ~"dev-tests-watir" qui feraient le tutorial (ou bien avoir un test ~"dev-tests-watir", avec des commentaires, qui, une fois extraits, do...Si on était pervers du test, on pourrait mettre des commandes dans le tutorial pour lancer des tests ~"dev-tests-watir" qui feraient le tutorial (ou bien avoir un test ~"dev-tests-watir", avec des commentaires, qui, une fois extraits, donnent le tutorial).
Pas sûr que cela apporte grand chose, normalement toutes les fonctionnalités sont déjà testées par ailleurs.https://gitlab.inria.fr/vidjil/vidjil/-/issues/2824Tutoriel : dire de filtrer par #Demo2020-09-28T00:25:09+02:00Mikaël SalsonTutoriel : dire de filtrer par #DemoQuand les gens ont plein d'échantillon, ils ne trouvent pas le Démo.Quand les gens ont plein d'échantillon, ils ne trouvent pas le Démo.https://gitlab.inria.fr/vidjil/vidjil/-/issues/2776Mettre à jour le tutoriel pour les TPs2017-11-20T19:18:05+01:00Mathieu GiraudMettre à jour le tutoriel pour les TPsQue mettre à jour dans le tutoriel ? Nouveautés 2016/17 ? Autres points ?
On le limite plutôt aux aspects clients. (Serveur: limiter à ce qui est accessible à partir du compte Demo ?).
@flothoni fait déjà une première passe, merci à toi...Que mettre à jour dans le tutoriel ? Nouveautés 2016/17 ? Autres points ?
On le limite plutôt aux aspects clients. (Serveur: limiter à ce qui est accessible à partir du compte Demo ?).
@flothoni fait déjà une première passe, merci à toi, et on en discute ce mercredi à 14h.
Voir aussi #2058 vdj#195 vdj#352Web 2017.112017-11-20https://gitlab.inria.fr/vidjil/vidjil/-/issues/2774Tip of the day: image2017-11-20T15:13:20+01:00Mathieu GiraudTip of the day: imageSuite à #2582, afficher l'image qui est dans `doc/tips` si elle est présente.Suite à #2582, afficher l'image qui est dans `doc/tips` si elle est présente.Ryan HerbertRyan Herberthttps://gitlab.inria.fr/vidjil/vidjil/-/issues/2755Documenter l'utilisation de Docker2017-12-13T09:31:43+01:00Mathieu GiraudDocumenter l'utilisation de Docker`doc/server.org` pourrait contenir des infos sur l'installation Docker.
Il faudra d'ailleurs un jour qu'on fasse une journée tutorial Docker pour tous, puis qu'on communique sur cette installation.`doc/server.org` pourrait contenir des infos sur l'installation Docker.
Il faudra d'ailleurs un jour qu'on fasse une journée tutorial Docker pour tous, puis qu'on communique sur cette installation.Ryan HerbertRyan Herberthttps://gitlab.inria.fr/vidjil/vidjil/-/issues/2742CLI: pouvoir ordonner les groupes d'options dans le -h2018-06-17T17:23:40+02:00Mathieu GiraudCLI: pouvoir ordonner les groupes d'options dans le -hBloque #2732.
Les groupes d’options sont par ordre alphabétique. Nous voulons avoir un ordre plus pertinent. Au pire, si on n'arrive pas, on mettra des 1/2/3 sur les groupes.Bloque #2732.
Les groupes d’options sont par ordre alphabétique. Nous voulons avoir un ordre plus pertinent. Au pire, si on n'arrive pas, on mettra des 1/2/3 sur les groupes.Algo 2018.08https://gitlab.inria.fr/vidjil/vidjil/-/issues/2722Écrire un document sur la qualité logicielle2019-03-19T11:16:06+01:00Mathieu GiraudÉcrire un document sur la qualité logicielleNotre doc de dev détaille déjà les tests. Nous devrions cependant avoir un document à destination des utilisateurs décrivant la qualité et liant si possible vers des résultats de tests.
vdj#500Notre doc de dev détaille déjà les tests. Nous devrions cependant avoir un document à destination des utilisateurs décrivant la qualité et liant si possible vers des résultats de tests.
vdj#500https://gitlab.inria.fr/vidjil/vidjil/-/issues/2679Un primo-utilisateur ne voit pas le lien "See results"2022-06-21T14:56:10+02:00Mathieu GiraudUn primo-utilisateur ne voit pas le lien "See results"Un utilisateur en contact avec @flothoni :
> Thanks a lot , I got result in multi+inc+xxx It seems an XML file.
> If I only want LGH V, D, J name in the result txt file, Is anyway I can do this?
Manifestement il a cliqué sur le lien ...Un utilisateur en contact avec @flothoni :
> Thanks a lot , I got result in multi+inc+xxx It seems an XML file.
> If I only want LGH V, D, J name in the result txt file, Is anyway I can do this?
Manifestement il a cliqué sur le lien `multi+inc+xxx` à côté de l'échantillon... Est-ce que ce n'est pas assez clair ? Comment mieux l'indiquer ?https://gitlab.inria.fr/vidjil/vidjil/-/issues/2594Tip of the day: images2017-11-20T15:10:51+01:00Mathieu GiraudTip of the day: imagesEssai dans f0fd50c.
- Fixer la taille (ici 300x300) ou pas ?
- Avoir un pointeur plus gros que normal ?
- Privilégier les jeux de Démo LIL-L3/L4 ?
Voir #2582.Essai dans f0fd50c.
- Fixer la taille (ici 300x300) ou pas ?
- Avoir un pointeur plus gros que normal ?
- Privilégier les jeux de Démo LIL-L3/L4 ?
Voir #2582.https://gitlab.inria.fr/vidjil/vidjil/-/issues/2588Documentation responsive2022-06-21T13:55:10+02:00Mathieu GiraudDocumentation responsivehttps://gitlab.inria.fr/vidjil/vidjil/-/issues/2581Tip of the day : avoir une liste de 20 tips2017-10-06T13:47:35+02:00Mathieu GiraudTip of the day : avoir une liste de 20 tipsProposition de @Cyanael et de tous
Voir aussi #1320 / #1945Proposition de @Cyanael et de tous
Voir aussi #1320 / #1945Web 2017.11https://gitlab.inria.fr/vidjil/vidjil/-/issues/2553Documenter légèrement BAM2017-08-30T09:09:13+02:00Mathieu GiraudDocumenter légèrement BAM@mikael-s, dans !67
> However I think this should remain a hidden feature for two reasons:
>
> 1. A BAM file is generally obtained by aligning reads to reference sequences. This could make people think they have to align their reads be...@mikael-s, dans !67
> However I think this should remain a hidden feature for two reasons:
>
> 1. A BAM file is generally obtained by aligning reads to reference sequences. This could make people think they have to align their reads beforehand.
>
> 1. In the case of paired-end sequencing, there is only one BAM file (but two FASTQ files). So the people could provide a single BAM file where reads have not been merged.
On pourrait mettre exactement ce type d'infos dans `doc/algo.org`, et ne pas en faire la pub dans `doc/user.org` et sur le serveur.Algo 2017.07Mikaël SalsonMikaël Salson