Faire un CodeBook avec RStudio

Auteur.e.s
Fabrice Dessaint, Inra
Résumé

Lorsque l’on travaille avec R, on écrit souvent de longs documents contenant du code (des scripts R). Pour s’y retrouver, on ajoute généralement des commentaires indiquant pourquoi et comment on a réalisé certaines des instructions présentes dans le script.

L’IDE RStudio, propose de générer un notebook à partir de n’importe quel script R, sous la forme d’un document au format .html, .pdf ou .docx.

Faire un codebook

Avec des packages comme Sweave (voir la fiche Introduire du code et des sorties R dans un document LaTeX avec Sweave, et le tutoriel Automatiser la production de documents), R.rsp (voir la fiche Créer des documents avec le package R.rsp) ou knitr on peut produire automatiquement des documents de type rapport où code, sorties et explications se mèlent.

Néanmoins, tous les scripts n’ont pas vocation à devenir des documents de type rapport. On peut écrire un script en réponse à une demande, pour illustrer une fonction, etc. L’IDE RStudio, propose de générer un notebook à partir de n’importe quel script R, sous la forme d’un document au format .html, .pdf ou .docx.

Par exemple, le script CodeBookExV2.R ci-dessous

# Exemple
data(airquality, package = "datasets")
# Test de Kruskal-Wallis
kruskal.test(Ozone ~ Month, data = airquality)
# Représentation graphique
boxplot(Ozone ~ Month, data = airquality)

traité par RStudio, génère, au choix, le document

  • CodeBookExV2.html
  • CodeBookExV2.pdf
  • CodeBookExV2.docx

La création du document, se fait depuis la fenêtre d’édition de RStudio, en cliquant sur l’icone située dans la barre d’outils

ou via la menu File/Compile Report… de RStudio.

Versions des outils utilisés
R version 3.4.2 (2017-09-28), RStudio version 1.1.383.
Thèmes de la fiche
Thèmes