Guide du débutant sur la syntaxe R Markdown (avec aide-mémoire)

Houssen Moshinaly

il y a 1 an

Vous connaissez probablement déjà le langage de balisage Markdown. Dans l’ensemble, c’est un langage simple et efficace pour créer des documents en texte brut.

Cependant, Markdown peut ne pas être suffisant pour faire des rapports détaillés ou des documents techniques.

Ainsi, R Markdown en tant que format de fichier interactif a vu le jour en 2014 grâce à des packages comme knitr et Pandoc. Il combine du texte brut avec du code R en ligne, vous aidant à créer un document dynamique.

Pour créer des documents R Markdown, vous pouvez utiliser divers IDE et extensions pour le rendre possible. Cependant, l’IDE officiel qui vous aide à le faire est RStudio. Ainsi, dans cet article, nous allons nous concentrer sur l’apprentissage de la syntaxe R Markdown à l’aide de RStudio.

💡 : Si vous ne saviez pas, le langage de programmation R est utilisé pour le calcul statistique, la représentation graphique et les rapports.

Contents

Configuration de RStudio
Syntaxe RMarkdown
R Markdown (aide-mémoire)

Configuration de RStudio

RStudio facilite le travail avec R Markdown grâce à son processus de configuration. Il vous suffit d’installer un package, et vous avez presque terminé !

Une fois que vous avez installé RStudio, allez dans le menu Outils et sélectionnez le Installer des packages option.

*Sélectionnez l’option Installer les packages dans le menu Outils.*

Dans la nouvelle boîte de dialogue, recherchez rmarkdown et installez-le.

💡 Pour utiliser des morceaux de code comme python, vous devez installer des packages supplémentaires. RStudio vous invitera à installer les packages requis lorsque vous essayez de les inclure dans votre document.

Une fois installé, vous pouvez démarrer un nouveau document rmarkdown en sélectionnant Fichier > Nouveau > RMarkdown.

Cela vous demandera d’ajouter des informations concernant le document (métadonnées du fichier). Remplissez-les.

Ou vous pouvez créer un document vide pour repartir à zéro.

Syntaxe RMarkdown

Puisque c’est juste un Markdown “amélioré“, la plupart des syntaxes restent les mêmes.

Il y aurait quelques différences lorsque vous ajouteriez des éléments qui ne sont généralement pas pris en charge par Markdown, comme les tableaux, les équations mathématiques, les morceaux de code, etc.

Voici un bref résumé de ce que nous couvrirons :

Nom du bloc RMarkdown	Syntaxe appropriée
Titre	# Niveau 1 ## Niveau 2 ### Niveau 3Niveau 1 =======Niveau 2 ——-
Accent	Italique _Italique_Gras__Gras__
Liste	Liste non ordonnée * Item * Item + Sub + SubListe ordonnée 1 Item 2. Item + Sub + Sub
Morceau de code	Bloc de code normal “` Le code va ici “` Bloc de code R “`{r} CODE R “` Vous pouvez également utiliser d’autres langages. “code” en ligne
Liens	Lien simple : collez l’URL Lien avec légende : [Text](URL_Adresse) Lien vers une rubrique : [Text](#Nom-de-la-section)
Tableau	\| Colonne \| Colonne \| Colonne \| \| —— \| —— \| —— \| \| Article \| Article \| Article \| \| Article \| Article \| Article \|
Équations	Equations en ligne : $Equations$ Afficher les équations : $$Équations$$
Images	Sans légende : ![](Lien vers l’image) Avec Légende : ![légende](Emplacement de l’image)
Bloc de citations	> Tapez vos blocs de citations
Divers	Super Script : Texte^Exposant^ Règle horizontale ou saut de page : ========= ou ———- Pour un saut de ligne manuel, fin de ligne avec 2+ espaces

En haut d’un document Rmarkdown, il y a un en-tête YAML entre deux ---. Ce bloc contient généralement un titre, un auteur, une date et le type de fichier que vous souhaitez générer, définissant le aspect final du document.

Le type de fichier est soit HTML, PDF ou Word.

---
title: "Sample"
author: "Houssen"
date: "2023-02-08"
output: pdf_document
---

Cela peut être ajouté lors de la configuration du nouveau document dans RStudio, comme indiqué dans la section ci-dessus.

Titre

Dans R Markdown, nous pouvons donner un entête selon deux méthodes différentes. Soit nous pouvons utiliser le caractère # pour différents niveaux d’en-tête comme :

# Entête niveau Level 1
## Entête niveau 2
### Entête niveau 3
#### Entête niveau 4
##### Entête niveau 5
###### Entête niveau 6

Ou, = et - pour les rubriques de niveau 1 et 2, respectivement.

Level 1 Heading
===============

Level 2 Heading
---------------

Listes

Il existe deux types de listes, la première est une Liste non ordonnée ou liste par puces :

* Item 1
* Item 2
		+ Sub 1
		+ Sub 2
* Item 3

Et le second est le Liste ordonnée qui est le type numéroté :

1. Item 1
2. Item 2
		+ Sub 1
		+ Sub 2
3. Item 3

Mettre en forme le texte dans un paragraphe

Il existe plusieurs façons de formater du texte.

Vous pouvez mettre l’accent sur le texte comme l’italique ou le gras en utilisant :

Italique : placez le texte entre des astérisques simples ou un trait de soulignement unique
Gras : placez le texte entre des doubles astérisques ou des doubles traits de soulignement.

*C'est un texte en italique*
_This is Italicized text_

**C'est un texte en gras**
__C'est un texte en gras__

Si vous souhaitez ajouter un exposant à un texte, placez le texte qui doit être en exposant entre le symbole ^.

Normal Text^^super_script^

Ou, si vous souhaitez ajouter du texte barré, placez le texte entre deux ~~ symbole.

~Texte barré~~

Ajout de morceaux de code

L’intégration du code est l’objectif principal de R Markdown. Il nous permet d’ajouter des codes de plusieurs façons.

Ajout d’un bloc de code normal.

Si vous souhaitez ajouter un bloc de code normal pour le séparer d’un autre texte, utilisez la syntaxe ci-dessous :

```
Votre code ici
```

Vous pouvez également essayer d’ajouter des blocs de code avec la coloration syntaxique.

Vous devez ajouter le langage entre accolades si vous souhaitez ajouter du code et intégrer sa sortie dans le document :

```{Language}
Your Code Goes Here
```

Ou, vous pouvez ajouter des codes en ligne en plaçant le texte respectif entre les symboles `.

	The `code` is a code

Voici à quoi cela devrait ressembler :

Liens

Pour ajouter un lien en texte brut, collez simplement le lien tel qu’il est dans une ligne.

https://maniacgeek.net

Ou, pour créer un lien hypertexte, utilisez la syntaxe :

[Text](URL Address)

Une autre façon d’ajouter un lien est de créer un lien vers une section de la page. Dans ce cas, utilisez la syntaxe :

[Text](#Name-of-section)

Les tableaux

La syntaxe pour ajouter des tables est similaire à celle de Markdown.

|Column|Column|Column|
| --- | --- | --- |
|Item|Item|Item|
|Item|Item|Item|

Images

Pour ajouter une image, utilisez la syntaxe :

![](http://example.com/logo.png)

ou

![légende facultative de l'image](figures/img.png)

Bloc de citations

RMarkdown vous permet d’ajouter des guillemets en bloc. Pour l’utiliser, utilisez le > (supérieur à) devant la ligne/le paragraphe que vous souhaitez citer.

Un text normal
>Un texte cité

Équations

En utilisant RMarkdown, vous pouvez ajouter des équations ou afficher des équations LaTex complexes.

Par exemple:

In line Pythagorean Theorem: $Equation$

Display Equation: $$Equation$$

Règle horizontale / Saut de page

Utilisez au moins trois astérisques ou tirets pour ajouter une règle horizontale ou un saut de page.

************

------------

Si vous souhaitez ajouter un saut de ligne manuel, terminez cette ligne par deux espaces ou plus.

R Markdown (aide-mémoire)

Que vous travailliez avec des rapports scientifiques ou que vous souhaitiez créer tout autre type de document dynamique, R Markdown est votre meilleur pari pour tirer le meilleur parti de Markdown.

Voici un aide-mémoire en anglais pour vous aider à tout résumer :

💬 Avons-nous oublié quelque chose que vous utilisez avec R Markdown ? Partagez vos pensées dans les commentaires ci-dessous.

Source