diff --git a/journal/Readme.md b/journal/Readme.md index d29c0cae7590d36552cd6c0c246339a81e2abcd0..783f184cbc9fbfe5ef090b8b716de750ba125b33 100644 --- a/journal/Readme.md +++ b/journal/Readme.md @@ -30,3 +30,106 @@ + +# Module 2 — **Le document computationnel** +*(MOOC « Recherche reproductible » – slides C028AL, 87 pages)* + +> Résumé synthétique des principaux messages et exemples, +> basé sur les diapositives de septembre 2018. :contentReference[oaicite:0]{index=0} + +--- + +## 1. Contexte et plan du module + +| Séquence | Contenu clé | +|----------|-------------| +| **M2-S0** | Définir ce qu’est un *document computationnel*. | +| **M2-S1** | Exemples d’études rétractées ou controversées. | +| **M2-S2** | Pourquoi la reproductibilité est difficile. | +| **M2-S3** | Principe du document computationnel. | +| **M2-S4A/B/C** | Prise en main : **Jupyter**, **RStudio**, **Org-mode**. | +| **M2-S5** | Travailler avec ses co-auteurs. | +| **M2-S6** | Comparaison détaillée des trois outils. | + +--- + +## 2. Études « fracassantes » : le besoin de transparence + +| Domaine | Cas cité | Problème identifié | +|---------|----------|--------------------| +| Économie | **Reinhart & Rogoff (2010)** : dette > 90 % ➜ croissance ↘︎ | Erreurs Excel, pondérations arbitraires (2013 re-analyse). | +| IRM fonctionnelle | Bug logiciel invalidant potentiellement *15 ans* de recherches (Eklund et al., 2016). | Taux de faux positifs sous-estimé. | +| Cristallographie | Structures de protéines (Chang, 2001-2005) | Colonnes de données inversées ➜ 5 rétractations. | +| Réplication | Oncologie : ≥ 50 % non reproduites ; Psychologie : ⅓ seulement. | Manque de données et de scripts fiables. | + +--- + +## 3. Pourquoi est-ce si difficile ? + +1. **Manque d’information** + - Données non partagées, choix méthodo non documentés. + - Pas de « cahier de labo » numérique. + +2. **Ordinateur = source d’erreurs** + - Tableurs « point-and-click » ➜ conversions indésirables (`MARCH1`→ date). + - Piles logicielles complexes : bugs, dépendances changeantes. + +3. **Organisation défaillante** + - Pas de sauvegarde ni d’historique versionné. + - Scripts éparpillés, noms de fichiers cryptiques. + +--- + +## 4. Le document computationnel : principe + +> **Tout regrouper dans un même fichier exécutable** + +- **Données** (ou lien vers dépôt). +- **Code** (cellules ou blocs). +- **Résultats** (tableaux, figures). +- **Narration** en langage naturel expliquant hypothèses & décisions. + +🎯 *But* : Traçabilité totale, ré-exécution à l’identique, partage facilité. + +--- + +## 5. Trois outils pratiques + +| Critère | **Jupyter Notebook** | **RStudio + R Markdown** | **Emacs Org-mode** | +|---------|----------------------|--------------------------|--------------------| +| Langage noyau | Multi-langages, focus **Python** | **R** natif, Python via `reticulate` | Tous via Babel | +| Fichier | `.ipynb` (JSON) | `.Rmd` (Markdown + YAML) | `.org` (texte pur) | +| Export | HTML / PDF / slides | HTML / PDF / Word | LaTeX, Beamer, HTML | +| Prise en main | Simple (Anaconda) | Simple pour R | Plus raide (Emacs) | +| Force | Interactivité, widgets | R écosystème + Pandoc | Contrôle total, reproductibilité fine | +| Limite | Merge Git compliqué | Graphiques Python moins fluides | Courbe d’apprentissage élevée | + +--- + +## 6. Collaborer efficacement + +1. **Versionner** (Git + plateforme publique). +2. **Lister dépendances** (`environment.yml`, `renv.lock`, Dockerfile). +3. **Tester sur les machines de chaque co-auteur**. +4. **CI** pour relancer le document à chaque modification. +5. **Relire mutuellement** le code ; plus d’excuse ! + +--- + +## 7. Bonnes pratiques récapitulatives + +- Structurer → titres, sections claires, mots-clés. +- Expliquer en clair le *pourquoi* de chaque étape. +- Ne pas commenter *chaque* ligne ; viser la lisibilité. +- Penser public cible (soi, collègues, reviewers). +- Diffuser de façon pérenne (GitLab + Zenodo DOI). + +--- + +## 8. À retenir + +> **Un document computationnel est la vitrine *et* l’envers du décor** : +> il montre les résultats publiables et révèle la mécanique reproductible. +> Sans cette double dimension, la science reste un château de cartes. + +