8.4 Documents de synthèse

Cette dernière étape s’attaque à la rédaction de documents finalisés qui servent à disséminer les résultats obtenus. C’est en théorie l’étape la plus courte des trois. Vous avez d’une part des données et des métadonnées correctement présentées (travail déjà réalisé à l’étape une). D’autre part, vous avez des carnets de notes où toutes vos analyses sont consignées (étape deux). Vous devez à présent extraire les éléments les plus pertinents en tenant compte du format de sortie du document de synthèse qui est le plus souvent imposé.

Il est possible de réaliser  :

  • un rapport (interne à l’équipe, et donc relativement informel, ou externe) avec un document R Markdown classique et le sortir en format HTML, PDF ou Word,
  • une publication scientifique avec, par exemple, le package {rticles},
  • un poster scientifique avec la package {posterdown},
  • une présentation sous forme de dias avec les packages {rmarkdown}, {xaringan} ou {revealjs},
  • une présentation interactive sous forme de “dashboard” avec Shiny et le package {flexdashboard},
  • un site web avec les packages {blogdown}, {distill)} ou {packagedown},
  • un document plus conséquent comme un ouvrage, un manuscrit de mémoire ou de thèse de doctorat avec le package {bookdown}.

Ce qui unifie l’ensemble des formats de sortie ci-dessus est qu’ils sont tous rédigés sur la base de documents R Markdown. Le livre R Markdown: The Definitive Guide donne une information détaillée sur ce format et reprend en long et en large une grande partie des formats de sortie possibles avec R Markdown. De plus, R Markdown Cookbook fournit un grand nombre d’astuces supplémentaires pour devenir expert dans l’utilisation de R Markdown.

La maîtrise de R Markdown dans des projets RStudio sous versioning Git est une compétence capitale en science des données. Elle vous permettra de vous hisser facilement au dessus de vos collègues biologistes qui ne maîtrisent souvent pas cet outil.

Au cours de la carrière d’un des auteurs, un travail de consultant a consisté à explorer de manière méthodique une grosse base de données. Pour chaque catégorie, les commanditaires voulaient un rapport détaillant différentes caractéristiques de cette catégorie. Chaque rapport individuel s’étalait facilement sur plusieurs dizaines de pages et devait présenter de nombreux graphiques. Ce travail aurait été extrêmement chronophage s’il devait être réalisé à la main dans Excel et Word. Mais avec R Markdown et quelques scripts R, le tout a pu être automatisé, et plus de 700 pages de rapports exhaustifs (répondant à la demande) ont pu être générés en quelques jours de travail seulement.

Pour des projets conséquent, le format {bookdown} est particulièrement intéressant. Vous ne l’avez pas encore utilisé, bien que vous y avez été confronté depuis le début. En effet, tout vos cours de science des données (i.e., les pages que vous êtes précisément en train de lire) sont rédigés avec cet outil. Vous allez maintenant apprendre par la pratique à utiliser ce format dans un gros projet personnel pour présenter vos résultats finaux.

À vous de jouer !

Réalisez l’assignation D08Ga_project.

Si vous êtes un utilisateur non enregistré ou que vous travaillez en dehors d’un cours, faites un “fork” de ce dépôt.

Voyez les explications dans le fichier README.md.