Merge branch 'master' of...

Merge branch 'master' of ssh://app-learninglab.inria.fr:9418/c356ed33d414d53760b5d8b0a508adc0/mooc-rr

module2/exo4/journal.ipynb

+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Journal de bord du Mooc / Mooc's logbook\n",
+    "\n",
+    "## Module 1\n",
+    "\n",
+    "Voir *Notes*.\n",
+    "\n",
+    "## Module 2\n",
+    "\n",
+    "*2021-02-17*\n",
+    "\n",
+    "<!-- :erreurs:, :document_computationnel: -->\n",
+    "\n",
+    "### 0. Introduction\n",
+    "\n",
+    "Document computationnel, qui permet de présenter à d'autres ses travaux, mais aussi montrer le détail du code et des calculs.\n",
+    "\n",
+    "### 1. Document computationnel\n",
+    "\n",
+    "- Étude liée aux politiques d'austérité: Erreurs liées à la non-publication des calculs qui ont conduit à la publication.\n",
+    "- Imagerie cérébrale: saumon mort qui présente des signes d'activités cérébrales >> données bruitées, menant à des erreurs d'interprétation. Potentielle remise en cause des résultats publiés ces 15 dernières années (40 000 articles environ), et données pas archivées.\n",
+    "- Fausses structures de protéines >> erreurs de programmation, même si l’acquisition des données était correcte.\n",
+    "\n",
+    "Pas un domaine de science est épargné. Problème méthodologique, mais également certainement sociologique. Dans les cas cités, manque de rigueur et de transparence.\n",
+    "\n",
+    "*2021-02-18*\n",
+    "\n",
+    "### 2. Pourquoi est-ce si difficile?\n",
+    "\n",
+    "<!-- :integration_continue:, :git:, :donnees: -->\n",
+    "\n",
+    "* Manque d'information:\n",
+    "  - Disponibilité des données\n",
+    "  - Explication des choix\n",
+    "  - D'où, utilisation d'un **cahier de laboratoire**.\n",
+    "\n",
+    "\n",
+    "* Ordinateur, source d'erreurs:\n",
+    "  - ERP meilleur que tableur pour la compta. Idem pour l'analyse de données.\n",
+    "  - Pile logicielle complexe, notamment avec logiciels propriétaires. Tout reprogrammer nous-même n'est pas non plus une solution. Analyser chaque brique.\n",
+    "\n",
+    "\n",
+    "* Manque de rigueur et d'organisation.\n",
+    "  - Sauvegarde\n",
+    "  - Mauvaise gestion de versions\n",
+    "  - Revue de code, intégration continue rarement utilisées dans la recherche\n",
+    "  - Dimension culturelle et sociale. La description d'un article ne devrait pas être la norme! Données trop nombreuses pour être décrites de façon exhaustive, idem pour les protocoles. Si personne n'exige les infos à quoi bon s'embêter à les fournir?\n",
+    "    - Cacher des infos peut être suspicieux. Mieux vaut prendre le risque que l'on détecte des erreurs.\n",
+    "    - Qn pourrait en tirer avantage? Oui mais il doit citer notre travail. De plus, les articles les plus cités sont des articles méthodologiques.\n",
+    "    - Possibilité de se faire une carte de visite avec GitHub, en mettant ses travaux à disposition.\n",
+    "    - Données sensibles? Dans ce cas, définir qui peut avoir accès aux infos. Méthodes cryptographiques. >> Informations semi-publiques.\n",
+    "\n",
+    "\n",
+    "**Outils à éviter**\n",
+    "- Logiciels propriétaires. Aucune garantie sur le long terme.\n",
+    "- Formats binaires non ouverts mènent presque systématiquement à de la perte de données.\n",
+    "- Services d'hébergement propriétaires.\n",
+    "- Tableurs et outils graphiques\n",
+    "\n",
+    "\n",
+    "**Meilleurs attitude à avoir: transparence.**\n",
+    "\n",
+    "\n",
+    "\n",
+    "### 3. Document computationnel\n",
+    "\n",
+    "Permettre la transparence la plus complète possible.\n",
+    "\n",
+    "- Acquisition de données: majeure partie du temps derrière un ordinateur.\n",
+    "- Visualisation\n",
+    "- Publication. Attention, l'article est la partie émergée de l'iceberg!\n",
+    "\n",
+    "Permettre de refaire le calcul:\n",
+    "- Vérifier\n",
+    "- Corriger\n",
+    "- Réutiliser\n",
+    "\n",
+    "Exemples document computationnel: Jupyter notebook, R studio ou Org mode. Principes:\n",
+    "  - Un seul document\n",
+    "  - Session\n",
+    "  - Export\n",
+    "\n",
+    "Jupyter: un peu compliqué d'eporter vers un PDF avec un template particulier. Avec Org mode, capacité à écrire directement du LaTeX.\n",
+    "\n",
+    "\n",
+    "On exporte souvent ensuite vers du PDF ou du HTML. Possibilité de spécifier si ou souhaite cacher certaines sections lors de l'export. Choix de partager le document final, ou bien le doc computationnel lui-même.\n",
+    "\n",
+    "\n",
+    "### 4. Prise en main de Jupyter\n",
+    "\n",
+    "<!-- :jupyter: -->\n",
+    "\n",
+    "Réexécuter le kernel afin d'avoir un notebook dans un état cohérent.\n",
+    "\n",
+    "Voir `Help > Keybord shortcuts`\n",
+    "\n",
+    "`tab`: complétion automatique\n",
+    "\n",
+    "`%matplotlib inline` utile?? Autres commandes magiques pour intéragir avec d'autres langages. Ex.: `%load_ext rpy2.python`, puis `%%R`.\n",
+    "\n",
+    "`commit & push` pour commiter le doc dans GitHub (uniquement dans le cas du MOOC?)\n",
+    "\n",
+    "`Edit > Cell toolbar > Hide code` pour cacher certaines parties.\n",
+    "\n",
+    "\n",
+    "### 5. Travailler avec d'autres\n",
+    "\n",
+    "Produire un document prêt à l'impression demande à avoir un environnement parfaitement configuré.\n",
+    "\n",
+    "- Co-auteurs enthousiastes: assurer le service après-vente, pas évident. Différents environnement, prise en main nécessaire... Ceci dit, favorise la reproductibilité.\n",
+    "\n",
+    "- Co-auteurs bienveillants: pas de soucis si le document est hébergé sur un cloud. Sinon, les co-auteurs peuvent uniquement éditer l'article avec un éditeur de texte. Le reste est de ma responsabilité.\n",
+    "\n",
+    "- Co-auteurs réfractaires:\n",
+    "  - un doc computationnel;\n",
+    "  - et un document plus classiques qui inclut les figures générées par le doc computationnel.\n",
+    "\n",
+    "Publier / partager documents:\n",
+    "- Attention à la pérénité! (ex.: Dropbox)\n",
+    "- GitHub ou GitLab: attention, on rend tout l'historique publique! Garder à l'esprit que à terme, les choses seront publiques. Sinon, faire le ménage et archiver l'état courant dans un site compagnon. Ex. archives ouvertes comme HAL. Possibilité de déposer des documents en annexe.\n",
+    "\n",
+    "\n",
+    "*2021-02-19*\n",
+    "\n",
+    "\n",
+    "### 6. Analyse comparée des outils\n",
+    "\n",
+    "- Cas d'un journal pour la prise de notes avec Org mode. Organisation chronologique, utilisation du mécanisme d'étiquettes pour s'y retrouver. Permet aussi de garder note du code associé si besoin, et de réexécuter à n'importe quel moment. Ensemble hétérogène mais facile à utiliser.\n",
+    "\n",
+    "- **Cahier de laboratoire**. Organisation sémantique. Sections avec expériences, analyses... Conventions à expliciter au début du document.\n",
+    "\n",
+    "- Article reproductible. Sections :noexport: avec des morceaux de code. Possibilité d'exporter le doc Org mode en Latex, avec un aspect tout à fait normal d'article. Possibilité de modifier facilement une figure en ré-exécutant le code intégré dans le documents. Liens vers le journal correspondant et vers GitHub permettant de revenir aux sources.\n",
+    "\n",
+    "Jupyter: lecture directe du ficheir JSOM un peu délicate. A l'inverse, ficheirs Rmd ou Org plus faciles à lire pour un être humain. Rédiger un article de bout en bout avec RStudio ou Org mode de plus en plus souvent faits; possible mais plus compliqué avec Jupyter.\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.4"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}