Rédaction de documents scientifiques
de haute qualité

Avec Quarto & RStudio


Ousmane Ouedraogo, BSc
Météorologiste
2022-09-19

Objectifs pédagogiques


Ce module est une introduction à la rédaction scientifique avec Quarto & RStudio conçu pour répondre aux objectifs suivants:

  • comprendre ce qu’est Quarto;

  • comprendre les liens entre Quarto et Pandoc;

  • apprendre la syntaxe Pandoc Markdown;

  • apprendre à créer des documents dynamiques avec Quarto via RStudio

  • Publication des résultats et rapports.

Hello Quarto


Quarto® est un système de publication scientifique et technique open source basé sur Pandoc.

Il permet de combiner du texte narratif et du code pour produire une sortie élégamment formatée sous forme de documents, de pages Web, d’articles de blog, de livres, etc.


Quarto prend en charge des dizaines de formats de sortie statiques et dynamiques, notamment HTML, PDF, MS Word, Beamer, des diapositives HTML5, des livres, des applications Shiny, des articles scientifiques, des sites Web, etc.

Contraire à son prédécesseur RMarkdown, Quarto n’est pas intimement lié à R & RStudio.

Pourquoi Quarto?


Tout d’abord il est multi-plateformes, Cross-Langage.

Auteur :Nick Tierney, https://www.njtierney.com/

Pourquoi Quarto?


Il permet de combiner graphiques, codes, figures et tables pour créer des documents statiques ou interactifs prêts à publier sans connaîtres Pandoc, Latex ou HTML.

Auteur: Allison Horst, https://github.com/allisonhorst/stats-illustrations

Comment ça marche ?

Tout part d’un simple document texte que vous aurez écrit, la magie s’opère en arrière-plan. Comme nous l’avons vu avec les sorciers de Alison 😃.

L’univers quarto

Quarto n’est pas intimement lié à R ou RStudio. On peut utilisé une variété de langage et d’éditeur de texte. Mais d’un point de vue pratique RStudio est bien indiqué on le verra de toute façon.

Avant de commencer


Nous avons besoin pour la suite d’avoir :


Vous aurez besoin aussi des packages R suivants : tidyverse , palmerpenguins et tinytex


install.packages(c("tidyverse","palmerpenguens","tinytex"))
library(tidyverse)
library(palmerpenguins)
library(tinytex)
tinytex::install_tinytex()


Pour l’installation, Suivre le guide pdf : “Installer R & RStudio, Quarto et Tinytex. Pas à pas.”

RStudio, l’environnement de travail

Présentation de l’interface.

Création de projet


Nous allons créer un projet Quarto pour mieux gérer un document Quarto ou un ensemble de documents, utilisez la commande Fichier : Nouveau Projet…, indiquez Nouveau Répertoire, puis choisissez Projet Quarto :

Rendu du projet “test”


Le fichier test.qmd est alors votre premier document Quarto. Yes 👊🏻.

Un premier document


Un document Quarto avec l’extension .qmd (à gauche) avec sa version rendue en HTML (à droite). D’autres format sont disponibles comme nous l’avons annoncé plutôt.

L’entête YAML


L’entête Yet Another Markup Langage contrôle le devenir du document, les possibilité sont nombreuses mais voici un cas type de document bien constitué.

title: "Mon rapport"
author: "Ousmane Ouedraogo"
affiliation: "AGRHYMET"
date: "02 Octobre 2022"
lang: fr
format: pdf
toc: true
lof: true
lot: true
toc-depth: 3
links-as-notes: true
number-sections: true
editor: visual
bibliography: references.bib

Markdown


Markdown est un système de publication et de formattage de texte minimaliste. C’est un langage de balise HTML.

Quarto se base sur le langage de balise Markdown, rendant ainsi l’édition du texte le plus simple possible. Mais on peut tout à fait intégré du code html. Pour rendre les choses simples, nous allons utilisés l’Éditeur Visuel de RStudio.

Formatage de texte


Syntaxe Markdown Sortie
*italique* et **gras**
italique et gras
exposant^2^ / indice~2~
exposant2 / indice2
~~barré~~
barré
`code`
code

Titrage du document


Syntaxe Markdown Sortie
# Titre 1

Titre 1

## Titre 2

Titre 2

### Titre 3

Titre 3

#### Titre 4

Titre 4

##### Titre 5
Titre 5
###### Titre 6
Titre 6

Editeur visuel RStudio


Ce que nous avons vu jusque là est beaucoup plus pénible. L’éditeur visuel est plus interréssant et offre une meilleure productivité. Tours rapides et raccourcis claviers.

Editeur visuel RStudio


L’éditeur visuel donne également des menus des menus de formatage et d’insertions, vous travaillerez aisément comme dans une suite bureautique !

Editeur visuel RStudio


Vous pouvez également utiliser le raccourci fourre-tout ⌘ / pour insérer à peu près n’importe quoi. Exécutez simplement le raccourci puis tapez ce que vous voulez insérer. Par exemple:

Partie pratique


Ecrivons notre premier article.

  • formatage de texte (gras, italique, code, puissance et indice)

  • Insertions : Figures, Tableau, liens, note de bas de page, citation, …

  • Pour les citations, bonus Zotero, Anystile.io

  • format pdf, html.

  • Equations latex : bonus Mathpix,

En savoir plus