La reproductibilité scientifique avec R via Rmarkdown et RStudio
DoAna - Statistiques Réunion
2021
Contexte
Cette formation est à destination de tout utilisateur de R (de très débutant à avancé).
L’un des principaux risques dans le cadre de la diffusion des résultats des analyses est l’erreur liée à la transition entre R et les outils de traitement de texte classiques (les fameux “copier-coller”). L’enjeu de cette formation est
- de vous fournir un outil et une méthodologie pour vous permettre d’optimiser la rédaction de vos documents (manuscrits de thèse, rapports et articles) et de gagner beaucoup de temps,
- le cas échant, de vous permettre de transmettre à votre tour ces compétences à vos étudiants.
Vous travaillerez sur vos propres données. Les activités de groupes et l’intelligence collective seront privilégiées !
Article du journal le monde sur la reproductibilité : Pour une recherche reproductible, publiez vos codes et données
Prérequis
Les participants doivent :
Avoir un ordinateur portable équipé de R (> 4.0.0), Rtools (pour les utilisateurs de Windows) et RStudio (> 1.4.0),
Avoir un projet R contenant :
- Un fichier script (.R) de moins de 100 lignes et qui produit au moins un graphique,
- un fichier texte illustrant le script
- au moins une image (.png, .jpeg, …)
- au moins un article de référence (au mieux sous format .bib)
⚠ Les candidats à la formation sont sujets à PRÉSÉLECTION!
Objectifs
- Comprendre la notion de reproductibilité
- Utiliser Rmarkdown pour faire un premier rapport automatisé
- Maîtriser des fonctionnalités liées à la création de fichiers Rmarkdown dans un environnement de développement adapté (RStudio)
- Être autonome dans sa propre découverte de l’univers de Rmarkdown
Déroulé
- Atelier de réflexion en intelligence collective autour de la notion de reproductibilité
- Quizz sur les problématiques liées au partage de vos scripts
- Création de votre premier rapport avec vos propres données
- Exercice pour découvrir les règles de mise en forme de Rmardown et la documentation publique
- Ateliers en sous-groupe pour personnaliser les rapports produits durant la matinée
- Présentation des outils pour aller plus loin
Note : Ceci n’est pas une formation à la programmation avec R !
Ressources pour aller plus loin
Documentation officielle de rmarkdown et pandoc
Thèmes (polices + couleurs)
- tout prêts : https://www.datadreaming.org/post/r-markdown-theme-gallery/
- personnalisation complète sans avoir à apprendre le css (je n’ai pas testé personnellement) : https://www.tillac-data.com/2020-fast-rmd-theming-with-thematic-and-bootstraplib/
- changer la couleur d’une partie du texte seulement : https://bookdown.org/yihui/rmarkdown-cookbook/font-color.html
Formats de sorties
livre : bookdown: Authoring Books and Technical Documents with R Markdown
rédaction scientifique : distill
présentation / slides : xaringan wiki
site internet : blogdown: Creating Websites with R Markdown
rapport interactif utilisant shiny : Débuter avec Shiny grâce à Rmarkdown
Exemples réels
Bibliothèque de livres libres d’accès écrits avec bookdown : bookdown - index
Exemples pour rédiger sa thèse : http://thesisdown.rbind.io/, https://github.com/remlapmot/bookdown-thesis, https://www.datascienced.co.uk/post/writing-your-thesis-with-bookdown/
Sites internet blogdown : le mien, Building your website using r blogdown, quelques autres ici, et encore plein ici