diff --git a/journal/Notes_on_module_2.md b/journal/Notes_on_module_2.md index 1d1084280d956ee20dbbc9fae1ed5ba575aef940..4e355f0369e35885e9fecc892a8f87677b761227 100644 --- a/journal/Notes_on_module_2.md +++ b/journal/Notes_on_module_2.md @@ -107,4 +107,47 @@ Différents outils mais un même principe : - export vers un autre format Différences entre les trois outils sont relativement mineures et portent sur : syntaxe, interopérabilité des langages, contrôle offert lors de l'export -OrgMode est pratique pour LateX \ No newline at end of file +OrgMode est pratique pour LateX + + +## Travailler avec les autres + +Pour produire un document prêt à l'impression à partir d'un document computationnel, il faut choisir dans tous les cas : +- quelles cellules cacher ? +- le bon style + +Cela demande d'avoir un environnement parfaitement configuré. +**Comment convaincre ses co-auteurs de faire des efforts ?** +Plusieurs réactions et approches possibles face à un nouvel outil. +Dans ce cas, il faut assurer le service après-vente : compatibilibité avec les environnements. Mais pratique pour la vérification. + +Si les co-auteurs sont réfractaires : il faut utiliser un document classique, avec notamment les figures générées. + +**Partager avec les autres** + +- Avec Rstudio : Rpubs : pas pérenne +- Dropbox et autres : pérénnité, accès... +- Gitlab / Github : on peut soit + - tout rendre public + - faire le ménage et archiver l'état courant dans un type compagnon -> outils Runmycode, archives ouvertes telles que HAL, figshare, zenodo + +**Notes prises à partir des questions** + +"Enfin, d'expérience, on surestime toujours la longévité des documents conservés sous forme numérique. La meilleure façon d'archiver est probablement d'imprimer le code source avec de l’encre d’archivage sur du papier non acide et le confier à un archiviste expérimenté qui en fera des copies et les disséminera dans des lieux sûrs. C'est une technique qui pourra sembler archaïque aux plus jeunes mais qui a fait ses preuves." + +A quoi se préparer quand on utilise un document computationnel : + +a. En laissant mes co-auteurs accéder et modifier facilement mon code, ils risquent de tout casser +b. Mes collaborateurs risquent de se rendre compte que je code comme un cochon et que je bidonne mes résultats (en imaginant que ça soit le cas... ;) +c. Je n’aurai plus d’excuse pour ne pas relire et vérifier le code de mes collaborateurs +d. Il faudra que mes co-auteurs et moi-même nous assurions que ça fonctionne sur chacune de nos machines et ça nous prendra du temps +e. Il faudra installer des tas de trucs compliqués alors que nos machines ne sont pas à jours + +Avantages de l'utilisation et de la publication d'un document computationnel : +a. Ce sont des outils relativement faciles à prendre en main, ce qui permet au plus grand nombre de se les approprier et de comprendre mon travail +b. Ces outils permettent d’avoir dans un seul document (1) un aperçu des données (2) du code (3) les résultats de calculs, et surtout (4) des explications sur comment ces trois types d’objets s’articulent les uns avec les autres +c. Cela permet d’être transparent sur la façon dont on arrive à telle ou telle conclusion +d. Cela permet à d’autres de plus facilement réutiliser tout ou une partie de nos procédures de calcul + +## Ressources complémentaires +[A R markdown template for academic manuscripts](http://svmiller.com/blog/2016/02/svm-r-markdown-manuscript/) \ No newline at end of file diff --git a/journal/module2-comparaison-outils.md b/journal/module2-comparaison-outils.md new file mode 100644 index 0000000000000000000000000000000000000000..9b797ef683ddcc928f2c930086a8f7089ad01f2c --- /dev/null +++ b/journal/module2-comparaison-outils.md @@ -0,0 +1,64 @@ +# Vidéo : Analyse comparée des différents outils + +## Un cours ou un tutoriel + +Un notebook Jupyter est un document dynamique, facile à prendre en main. + +## Un journal + +Journal en org-mode : prise de notes sur les réunions, le code, etc. + +- un seul auteur +- organisation chronologique +- étiquettes sur chaque entrée ; très faciles à filtrer sur OrgMode +- contient : notes, liens, codes (pour éventuellement pouvoir le réutiliser plus tard) + +## Cahier de laboratoire en org-mode + +Ici : cahier de labo informatique +Sections : +- expériences +- analyses + +Au sein de ces sections : organisation dans l'ordre chronologique + +## Un article reproductible + +Utilisation de org-mode +Permet d'avoir : +- plusieurs auteurs +- régénération des figures +- permet au lecteur averti de revenir aux sources + +## Conclusion de la vidéo ... + +Utilisation de Rstudio/knitr facile, mais navigation limitée. Ecriture d'un article : possible. +Org-Mode : utilisation plus complexe, mais navigation puissante. Pas spécifique d'un langage particulier. +Jupyter : environnement web, très facile d'accès + +**L 'outil importe peu** : ce qui importe c'est : +- collecter l'information +- l'organiser et la rendre exploitable +- la rendre disponible + +Mais ces trois environnements sont matures. + +## Notes d'après les questions + +Ces trois environnements fonctionnement sur tous les systèmes d'exploitations. +Jupyter, OrgMode et Rstudio se distinguent par : +a. La facilité d’installation et de prise en main +b. L’année de création et le langage sous-jacent +c. La capacité à rédiger des documents respectant un style bien spécifique et prêt à la soumission à un journal ou une conférence +d. Le format de fichier utilisé (JSON pour Jupyter, Rmd pour Rstudio, Org pour Org-Mode) + +L'utilisation de l'un ou de l'autre des trois documents se justifie par : +- le type de document que l'on souhaite rédiger +- le public amené à l'utiliser + +Pour que l'information d'un document computationnel soit exploitable, il est important de : +Gérer le document à l’aide d’un gestionnaire de version +a. Structurer le document pour le rendre le plus lisible possible +b. Expliquer en langage naturel l’idée générale derrière un calcul ainsi que pourquoi on prend telle ou telle décision de calcul +c. Utiliser des mots-clés pour faciliter l’indexation et la navigation +d. Réfléchir à qui l’information s’adresse \ No newline at end of file