Dans RStudio

Tout est préinstallé.

En dehors de RStudio

• Extension rmarkdown (et ses dépendances)
• pandoc

Dans tous les cas

• Pour générer du PDF : une installation fonctionnelle de \(\mathrm{\LaTeX{}}\) (MikTeX, MacTeX, TeX live…).

Plus d'infos sur la version de Markdown utilisée par RMarkdown :

• Markdown Quick Reference dans l'aide de RStudio
• En ligne sur le site de RStudio : http://rmarkdown.rstudio.com/authoring_pandoc_markdown.html
• En ligne sur le site de Pandoc : http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown

Deux types de blocs de code :

En bloc

‵‵‵{r}
print(nrow(mtcars))
‵‵‵

En ligne

Le tableau a ‵r nrow(mtcars)‵ lignes.

Sous RStudio

• Boutons Knit HTML, Knit PDF…

Script ou console

• Fonction render() (de rmarkdown).

Il y a deux types de configuration :

• Configuration du rendu du document : rmarkdown
• Configuration du rendu des blocs de code : knitr

La configuration de rmarkdown se fait dans un en-tête au format YAML :

---
title: "Un zouli titre"
author: "Machin Bidule"
date: "18/11/2014"
output: html_document
---

Elle permet de définir :

• les métadonnées du document
• le format du document à générer
• des options propres à chaque format

Les options de knitr permettent de modifier le comportement des blocs de code.

Par bloc

‵‵‵{r nom_du_bloc, echo=FALSE, cache=TRUE}
print(nrow(mtcars))
‵‵‵

Pour l'ensemble des blocs

‵‵‵{r}
opts_chunk$set(echo=FALSE)
‵‵‵

Tableaux

Fonction kable() de knitr

Équations

Syntaxe \(\mathrm{\LaTeX{}}\), rendue selon le format de sortie (natif, Mathjax…)

Bibliographie

RMarkdown lit les bases de références selon différents formats (BibTeX, EndNote…) et gère les citations et la génération de la bibliographie (HTML, PDF, Word).

Il est possible de personnaliser l'apparence du document généré :

• en déclarant un document avec des styles de référence (Word)
• en utilisant une CSS personnalisée (HTML)
• en incluant des fichiers en en-têtes, pied de page (HTML et PDF)

On peut également utiliser des formats et des templates distribués avec rmarkdown ou fournis par d'autres extensions :

• template tufte_handout
• templates de différentes revues (extension rticles)
• templates HTML (extension rmdformats)

Possibilités de générer des slides selon le même principe.

• format beamer (PDF)
• format slidy (HTML)
• format ioslides (HTML)

Nombreuses options spécifiques.

• Faire un site Web statique ou avec un moteur de blog type Jekyll
• Graphiques interactifs avec ggvis (HTML, RStudio ou Shiny server)
• Documents dynamiques et interactifs avec shiny (HTML, RStudio ou Shiny server)

Avantages

• Avantages de Sweave : mise à jour, reproductibilité…
• Un format d'entrée, plusieurs formats de sortie
• Syntaxe Markdown facile à utiliser et mémoriser
• Développement dynamique
• Documentation très complète (en anglais)

Inconvénients

• Encore jeune, quelques bugs
• Difficile de personnaliser la présentation en gardant de multiples formats de sortie
• Beaucoup d'options, à la fois pour rmarkdown et pour knitr

Tout est là : http://rmarkdown.rstudio.com/

Et notamment l'antisèche (cheat sheet) (PDF, 2 pages) : http://rmarkdown.rstudio.com/RMarkdownCheatSheet.pdf

Et le guide de référence (PDF, 3 pages) : http://rmarkdown.rstudio.com/RMarkdownReferenceGuide.pdf

Site de knitr : http://yihui.name/knitr/

Site de pandoc : http://johnmacfarlane.net/pandoc/