Initiez-vous à Quarto
Lorsque vous allez faire une analyse de données, vous aurez besoin de rédiger du code pour faire les statistiques, les graphiques, les tests, mais aussi du texte pour décrire ce que vous faites et conclure sur votre analyse.
Vous vous attendez peut-être à devoir jongler entre un traitement de texte et RStudio, sachez qu’il n’en est rien. Grâce à Quarto, vous allez pouvoir inclure votre code dans votre rédaction.
Cela signifie que l’on ne va pas coder tout de suite ?
Eh non, pas encore, je préfère vous donner les moyens d’utiliser les outils à votre disposition plutôt que de vous jeter directement du code au visage.
Une fois que vous aurez pris les bonnes pratiques, il vous sera plus facile de développer du bon code.
Quarto laisse la part belle au texte et non au code car il est basé sur le principe What You See Is What You Want et non pas What You See Is What You Get, comme les logiciels de traitement de texte type Word, Mot ou autre.
Cela peut paraître inutilement compliqué d’utiliser unesyntaxe plutôt qu’un clic-bouton pour modifier l’apparence d’un texte, mais avec un peu d'entraînement c’est beaucoup plus simple.
Par exemple, si vous souhaitez faire un titre marquant pour un de vos documents en alternant majuscule, minuscule, gras, italique… vous devrez sélectionner chaque lettre l’une après l’autre pour appliquer la mise en forme : cRéezunscRiptdansR ; avec la syntaxe Markdown, sur laquelle se base Quarto, cela donnerait ça :**c**R*é***e***z* *u***n** **s***c**R**i***p*****t*** *d*a**n***s* **R** .
😱 Mais c’est illisible !
😂 Oui un peu, mais c’est surtout une question d’habitude et il est rare d’avoir un changement de format à chaque lettre, la plupart du temps les balises entourent un ou plusieurs mots !
Voici un rapide tour d’horizon de la syntaxe, pour plus d’informations :
Le saut de ligne est marqué par un double espace (en fin d’une ligne).
Les étoiles servent à marquer :
En italique :
*italique*.En gras :
**gras**.En gras et italique :
***gras et italique***.
Pour raturer on utiliser les tildes :
~~raturé~~.Pour la syntaxe
codeles impostropes :`code`.Les titres sont précédés de
#, autant que de niveaux :Titre de premier niveau :
# Titre de premier niveau.Titre de deuxième niveau :
## Titre de deuxième niveau.Titre de troisième niveau :
### Titre de troisième niveau...
Cette syntaxe est aussi parfaitement adaptée pour ajouter des liens, des images et tous types de ressources.
Quarto permet de générer plusieurs formats de sortie : .pdf , .html , .js ... à partir d’un même fichier d'origine.
Et enfin, Quarto a une organisation simple :
Un en-tête facultatif YAML, c’est-à-dire que les informations sous forme de listes paramètrent le document sans l’utilisation de balise. Par exemple vous pouvez renseigner le titre du document, votre nom, la date…
Des portions de texte avec la syntaxe Markdown et des petit* plus Quarto.
Des morceaux de code, chunk en anglais. Le langage utilisé, R par défaut, est visible entre accolades.
{r}
Prêt à créer votre premier script ?
Lisez un script généré automatiquement
Juste avant nous avons vu ensemble les grandes lignes des scripts Quarto, commençons maintenant par en lire un. Les grandes étapes que vous retrouverez dans la vidéo ci-dessous :
Créez un nouveau document Quarto
File > New File > Quarto Documentou en utilisant le raccourci.Choisissez les options de votre document. Toutes les options sélectionnées ici peuvent être modifiées après la création du document.
Créez le document et générez une sortie sous format
.htmlet.pdf.Versionnez avec Git.
Maintenant que vous avez créé votre premier document Quarto, on le modifie ensemble ?
Modifiez un script généré
Pour faciliter cette première prise en main, nous allons partir du document généré automatiquement dans RStudio.
Vous pouvez visualiser un document Quarto sous la forme What You See Is What You Get via l’éditeur Visual ou sous la forme What You See Is What You Want via l’onglet Source.
Pour faire les modifications ici, je vous demanderai de passer sous le format Source afin de profiter de la flexibilité du Markdown.
Modifiez le format de sortie
La première modification à réaliser est de changer le format de sortie pour faire un PDF. Pour cela, dans l’en-tête, vous allez écrire pdf à la place de html et lancer la compilation du document en cliquant sur Render (la grosse flèche bleue).
Conseil n° 4 pour éviter les erreurs : Enregistrez régulièrement vos fichiers.
Par défaut, le fichier est enregistré à chaque compilation avec Render , mais c’est mieux d’enregistrer plus souvent.
Par rapport à Git, il est conseillé de faire un commit (enregistrer une version d’un ou plusieurs fichier(s)) avant et après chaque développement. Par exemple, faites un commit avant d'importer vos données dans R et après avoir écrit le code et les avoir importées.
Pour améliorer la lisibilité des documents, vous pouvez rajouter un sommaire cliquable en faisant :
format:pdf:toc: trueAjoutez du texte
En amont du texte déjà écrit, vous allez rajouter un paragraphe d’introduction. Le titre de ce paragraphe sera de deuxième niveau, comme ceux présents ici## :
Le mot paragraphe est en gras car entouré de deux étoiles, le mot Quarto est en italique car entouré d’une étoile et les mots reproductibilité, réutilisation et transmission en gras et en italique car entourés de trois étoiles.
Les mots R et RStudio sont affichés sous le format code .
Ajoutez un média (image, lien hypertexte…)
L’ajout d’une image se fait via la syntaxe Markdown.
L’ajout d’un lien hypertexte est assez similaire, avec le texte à afficher entre les crochets et l’adresse du lien entre les parenthèses :
[Le site de formation OpenClassrooms](https://openclassrooms.com/)Créez un nouveau chunk
Pour ajouter un nouveau chunk, vous pouvez cliquer sur le carré vert en haut à droite de votre fenêtre de script ou utiliser le raccourci Ctrl + Alt + I.
Dans le chunk :
Créez un objet a égal à 2 grâce à la ligne de commande
a <- 2.Multipliez ensuite a par 2 grâce à la ligne de commande
a * 2.
Pour envoyer le code dans la console, cliquez sur la flèche verte ou utilisez le raccourci Ctrl + Entrée.
Conseil n° 5 pour éviter les erreurs : Attention à la casse.
R, comme beaucoup de langages de programmation, est sensible à la casse, c’est-à-dire qu’il fait la différence entre majuscule et minuscule. Si vous créez l’objet a puis qu'ensuite vous écrivezA * 2, R affiche une erreur en vous disant que A est un objet inconnu.
La bonne pratique est d’utiliser les minuscules et d’écrire ensnake_case, c’est-à-dire en détachant les mots écrits en minuscules par des underscores.
OK, au final ce n’est pas si compliqué que ça, mais comment je fais mon propre script ?
Deux solutions existent :
Prendre un script qui existe déjà et le modifier. Ce que vous venez de faire.
Prendre un script vide en cliquant sur la case Create Empty Document. Ce que vous êtes invité à faire juste après !
À vous de jouer
Merci d’avoir suivi jusqu’ici, maintenant c’est à vous de jouer !
Ensemble nous allons créer un script dans lequel vous sauvegarderez toutes les bonnes pratiques distillées dans ce cours. Vous pouvez choisir de le compiler sous format HTML ou PDF, à votre convenance.
Créez un document Quarto vide :
New File > Quarto Document > Create Empty Document.Passez en Source et donnez-lui un titre. Par exemple : “Guide des bonnes pratiques en R”.
Créez un premier paragraphe d’introduction en expliquant le but de ce document.
Copiez-collez les 5 conseils donnés dans ce cours.
Compilez votre document.
En résumé
Quarto permet d’alterner code et texte et d’améliorer la réutilisation et la conservation de l’analyse de données réalisée.
Le code est enregistré dans des chunks paramétrables.
La mise en forme du texte avec Quarto utilise une syntaxe simple et basée sur le Markdown.
Quarto permet de compiler sous plusieurs formats de sortie.
Pour être activé, le code doit être envoyé dans la console par le raccourci Ctrl + Entrée ou les flèches vertes Run.
Bravo, vous avez beaucoup appris sur la mise en place, il ne reste plus qu’à appliquer sur des données !
