8  R Markdown dans VSCode pour R

Mots clés

R Markdown dans VSCode pour R, Génération de Rapports en R, rapports dynamiques dans R, VSCode pour R Markdown, Tutoriel R Markdown

8.1 Introduction

R Markdown est un outil puissant pour créer des rapports dynamiques qui combinent le code, la narration et les visualisations. Dans ce chapitre, nous allons explorer comment configurer et utiliser R Markdown dans VSCode pour générer des rapports et des documents reproductibles.



8.2 Prérequis

  • Installer les outils essentiels pour la programmation R dans VSCode comme indiqué dans les chapitres précédents (Chapitre 2 et Chapitre 3).
  • Assurez-vous d’avoir le package rmarkdown installé dans R et l’extension vscode-R dans VSCode, ainsi que Pandoc pour convertir les documents R Markdown en différents formats de sortie. Pandoc est préinstallé avec RStudio, mais vous pouvez également l’installer séparément à partir du site officiel de Pandoc.

8.3 Créer un document R Markdown

Pour créer un nouveau document R Markdown dans VSCode, procédez comme suit:

  1. Créer un nouveau fichier : Dans VSCode, cliquez sur File > New File, puis sauvegardez-le avec l’extension .Rmd (par exemple, report.Rmd).

  2. Ajouter un en-tête YAML : Commencez par ajouter un en-tête YAML au début de votre fichier. Cet en-tête définit le titre du document, l’auteur, le format de sortie et d’autres métadonnées.

    ---
title: "Rapport d'analyse des données"
author: "Your Name"
date: "2024-12-06"
output: html_document
---

  3. Ajouter du contenu : Vous pouvez mélanger des morceaux de code R, du texte et des visualisations dans votre document R Markdown. En utilisant les triples crochets avec {r} pour créer un morceau de code.

    ## Introduction

Voici un exemple de document R Markdown dans VSCode.

```{r}
summary(cars)
```

8.4 Exécuter du code R dans R Markdown

Placez votre curseur à l’intérieur d’un morceau de code et utilisez les raccourcis suivants:

  • Lancez le Code Chunk : Appuyez sur Ctrl + Shift + Enter (Windows/Linux) ou Cmd + Shift + Enter (Mac) pour exécuter le morceau de code courant.
  • Lancez une ligne ou une sélection : Appuyez sur Ctrl + Enter ou Cmd + Enter pour exécuter la ou les lignes de code sélectionnées.

La sortie du code s’affiche directement sous le morceau, ce qui permet d’obtenir un retour d’information et des résultats immédiats.

8.5 Générer des résultats

R Markdown vous permet de générer des documents dans différents formats, tels que HTML, PDF et Word. Pour rendre le document dans VSCode:

  1. Ouvrez la palette de commandes : Appuyez sur F1 ou Ctrl + Shift + P pour ouvrir la palette de commandes.
  2. Lancer la commande Knit : Tapez rmarkdown : Render et sélectionnez le format de sortie souhaité (par exemple, HTML, PDF).
  3. Afficher la sortie : Le document généré sera sauvegardé dans le même répertoire que votre fichier .Rmd. Vous pouvez afficher la sortie HTML directement dans votre navigateur ou ouvrir un document PDF/Word.

8.6 Personnalisation de la sortie R Markdown

VSCode vous permet de personnaliser la sortie de vos documents R Markdown en éditant l’en-tête YAML ou en ajoutant des paramètres personnalisés.

  • Thèmes et mise en évidence : Vous pouvez changer l’apparence de votre document en spécifiant différents thèmes et styles de surlignage dans l’en-tête YAML.

    output:
  html_document:
    theme: united
    highlight: tango

  • Paramétrage : Les documents R Markdown peuvent être paramétrés, ce qui vous permet de créer des rapports dynamiques basés sur les entrées de l’utilisateur.

    params:
  data_file: "data.csv"

    Vous pouvez ensuite utiliser params$data_file dans votre code R pour faire référence au fichier spécifié.

8.7 Code en ligne et texte dynamique

R Markdown prend en charge le code en ligne pour ajouter du contenu dynamique à votre rapport. Par exemple, vous pouvez inclure la date du jour ou des valeurs calculées directement dans le texte:

À partir de `{r} Sys.Date()`, la donnée contient `{r} nrow(cars)` observations.

Cette fonction est particulièrement utile pour créer des rapports reproductibles qui se mettent à jour automatiquement lorsque les données changent.

8.8 Meilleures pratiques pour la génération de rapports

  • Organiser le code en morceaux : Organisez votre code en morceaux logiques et étiquetez chaque morceau pour une référence facile.

    ```{r load-data, echo=FALSE}
data <- read.csv("data.csv")
```

  • Utilisez la mise en cache : Pour les computations qui prennent du temps, utilisez l’option cache = TRUE pour éviter de ré-exécuter le code à chaque fois que vous knit le document.

    ```{r model, cache=TRUE}
model <- lm(mpg ~ wt + hp, data = mtcars)
```

  • Cacher le code ou la sortie : Vous pouvez contrôler la visibilité du code et de la sortie en utilisant les options de chunk comme echo, results, and include.

    ```{r, echo=FALSE}
plot(mtcars$wt, mtcars$mpg)
```

8.9 Conseils pour utiliser R Markdown dans VSCode

  • Live Preview : Utilisez l’extension [Live Preview extension] (https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) pour voir les changements en temps réel pendant que vous éditez votre document R Markdown.
  • Pliage de code : VSCode vous permet de plier et déplier des morceaux de code, ce qui rend plus facile la navigation dans de grands documents.
  • Linting et formatage : En utilisant les packages lintr et styler pour la mise en forme de votre code R Markdown afin de maintenir la lisibilité et la cohérence.

8.10 Exemple de contenu de fichier d’un document R Markdown

8.10.1 Code source

---
title : 'Exemple de rapport pour R Markdown'
author: 'Datanovia'
date: '`{r} Sys.Date()`'
output: html_document
---

## Introduction

Ce document R Markdown fournit une démonstration simple de l'utilisation du code, du texte et des visualisations pour créer un rapport interactif.



## Résumé de l'ensemble de données `cars`

L'ensemble de données `cars` dans R contient des données sur la vitesse et la distance d'arrêt datant des années 1920. Voici un résumé des données:

```{r}
summary(cars)
```

## Graphique de nuage de points de la vitesse par rapport à la vitesse de la voiture. Distance d'arrêt

Créons un graphique de nuage de points pour visualiser la relation entre la vitesse et la distance d'arrêt:

```{r}
plot(cars$speed, cars$dist,
     xlab = "Speed (mph)",
     ylab = "Distance d'arrêt (ft)",
     main = "Speed vs. Distance d'arrêt")
```

## Conclusion

Voici un exemple simple de la manière dont vous pouvez utiliser R Markdown pour créer des rapports informatifs et de visualisation. Vous pouvez mélanger du texte, du code R et des visualisations pour produire un contenu dynamique.

N'hésitez pas à ajouter d'autres sections, analyses ou visualisations au fur et à mesure que vous continuez à explorer la puissance de R Markdown!

8.10.2 Sortie d’exécution

Exécution du document R Markdown dans VSCode

8.11 Conclusion

R Markdown dans VSCode fournit un moyen flexible et efficace de créer des rapports dynamiques et reproductibles. Vous pouvez générer des documents de qualité professionnelle qui intègrent le code, l’analyse et la visualisation.