Créer des tableaux Markdown de manière programmée en R avec KnitR

Question

Je viens tout juste de commencer à apprendre à propos de KnitR et de l'utilisation de Markdown pour générer des documents et des rapports en R. Cela semble parfait pour beaucoup des rapports quotidiens que je dois faire dans mon travail. Cependant, une chose que je ne semble pas voir est un moyen simple d'imprimer des data frames et des tables en utilisant le format Markdown (un peu comme xtable, mais avec Markdown au lieu de LaTeX ou HTML). Je sais que je peux simplement incorporer la sortie HTML de xtable, mais je me demandais s'il existait des solutions basées sur Markdown?

Answer 1

Désormais, le package knitr (depuis la version 1.3) inclut la fonction kable pour la création de tables :

> library(knitr)
> kable(head(iris[,1:3]), format = "markdown")
|  Sepal.Length|  Sepal.Width|  Petal.Length|
|-------------:|------------:|-------------:|
|           5,1|          3,5|           1,4|
|           4,9|          3,0|           1,4|
|           4,7|          3,2|           1,3|
|           4,6|          3,1|           1,5|
|           5,0|          3,6|           1,4|
|           5,4|          3,9|           1,7|

À JOUR : si vous obtenez des balises markdown brutes dans un document, essayez de configurer l'option de chunk results = "asis".

Answer 2

Deux packages qui feront cela sont pander

library(devtools)
install_github('pander', 'Rapporter')

Ou ascii

pander est une approche légèrement différente pour la construction de rapports, (mais peut être utile pour cette fonctionnalité).

ascii vous permettra d'utiliser print avec type = 'pandoc (ou diverses autres saveurs de markdown)

library(ascii)
print(ascii(head(iris[,1:3])), type = 'pandoc')

    **Sepal.Length**   **Sepal.Width**   **Petal.Length**  
--- ------------------ ----------------- ------------------
1   5.10               3.50              1.40              
2   4.90               3.00              1.40              
3   4.70               3.20              1.30              
4   4.60               3.10              1.50              
5   5.00               3.60              1.40              
6   5.40               3.90              1.70              
--- ------------------ ----------------- ------------------

Remarquez que dans ces deux cas, l'utilisation de pandoc est recommandée pour convertir du markdown vers votre type de document désiré, cependant l'utilisation de style='rmarkdown' créera des tables compatibles avec ce package markdown et la conversion intégrée dans rstudio.

Answer 3

Je voulais juste mettre à jour ceci avec ce que j'ai décidé de faire. J'utilise actuellement le package hwriter pour imprimer des tables et j'utilise les fonctionnalités row.* et col.* pour ajouter des classes CSS à différents éléments. Ensuite, j'ai écrit du CSS personnalisé pour afficher comme je le voulais. Donc, voici un exemple au cas où quelqu'un d'autre rencontre quelque chose de similaire.

Tout d'abord, créez un fichier qui fera le knitting et convertira le Markdown en HTML :

FICHIER : file_knit.r
#!/usr/bin/env Rscript

library(knitr)
library(markdown)

knit("file.Rmd")
markdownToHTML("file.md","file.html",stylesheet="~/custom.css")

Ensuite, créez le fichier Markdown réel :

FICHIER: file.Rmd
Rapport sur les choix de fruits vs. d'animaux
==================================

Il s'agit d'un rapport sur les choix de fruits vs. d'animaux.

```{r echo=FALSE,results='asis'}
library(hwriter)
set.seed(9850104)
my.df <- data.frame(Var1=sample(x=c("Pomme","Orange","Banane"),size=40,replace=TRUE),
                    Var2=sample(x=c("Chien","Chat","Lapin"),size=40,replace=TRUE))

tbl1 <- table(my.df$Var1,my.df$Var2)

tbl1 <- cbind(tbl1,rowSums(tbl1))
tbl1 <- rbind(tbl1,colSums(tbl1))

colnames(tbl1)[4] <- "TOTAL"
rownames(tbl1)[4] <- "TOTAL"

# Parce que j'ai utilisé results='asis' pour ce chunk, je peux simplement utiliser cat() et hwrite() 
# pour écrire le tableau en HTML. En utilisant la fonction row.* de hwrite(), je peux assigner des classes
# aux différents éléments du tableau.
cat(hwrite(tbl1,
           border=NA,
           table.class="t1",
           row.class=list(c("header col_first","header col","header col","header col", "header col_last"),
                          c("col_first","col","col","col","col_last"),
                          c("col_first","col","col","col","col_last"),
                          c("col_first","col","col","col","col_last"),
                          c("footer col_first","footer col","footer col","footer col","footer col_last"))))
```

Enfin, créez simplement un fichier CSS personnalisé.

FICHIER : custom.css
body {
  font-family: sans-serif;
  background-color: white;
  font-size: 12px;
  margin: 20px;
}

h1 {font-size:1.5em;}

table {
  border: solid;
  border-color: black;
  border-width: 2px;
  border-collapse: collapse;
  margin-bottom: 20px;
  text-align: center;
  padding: 0px;
}

.t1 .header {
  color: white;
  background-color: black;
  border-bottom: solid;
  border-color: black;
  border-width: 2px;
  font-weight: bold;
}

.t1 .footer {
  border-top: solid;
  border-color: black;
  border-width: 2px;
}

.t1 .col_first {
  border-right: solid;
  border-color: black;
  border-width: 2px;
  text-align: left;
  font-weight: bold;
  width: 75px;
}

.t1 .col {
  width: 50px;
}

.t1 .col_last {
  width: 50px;
  border-left: solid;
  border-color: black;
  border-width: 2px;
}

Exécuter ./file_knit.r me donne file.html, qui ressemble à ceci :

Donc, j'espère que cela pourra être utile à d'autres qui veulent un peu plus de mise en forme dans la sortie Markdown !

Answer 4

Il y a des fonctions dans le package pander:

> library(pander)
> pandoc.table(head(iris)[, 1:3])

-------------------------------------------
 Sepal.Length   Sepal.Width   Petal.Length 
-------------- ------------- --------------
     5.1            3.5           1.4      

     4.9             3            1.4      

     4.7            3.2           1.3      

     4.6            3.1           1.5      

      5             3.6           1.4      

     5.4            3.9           1.7      
-------------------------------------------

Answer 5

Il n'est pas très difficile de créer votre propre fonction personnalisée. Voici une preuve de concept très simple pour générer un tableau rmarkdown d'un data.frame:

   rmarkdownTable <- function(df){
      cat(paste(names(df), collapse = "|"))
      cat("\n")
      cat(paste(rep("-", ncol(df)), collapse = "|"))
      cat("\n")

      for(i in 1:nrow(df)){
        cat(paste(df[i,], collapse = "|"))
        cat("\n")
        }
    invisible(NULL)
    }

Dans le document .Rmd, vous utiliseriez ensuite la fonction avec results = 'asis':

```{r, results = 'asis'}
rmarkdownTable <- function(df){
  cat(paste(names(df), collapse = "|"))
  cat("\n")
  cat(paste(rep("-", ncol(df)), collapse = "|"))
  cat("\n")

  for(i in 1:nrow(df)){
    cat(paste(df[i,], collapse = "|"))
    cat("\n")
    }
invisible(NULL)
}

rmarkdownTable(head(iris))
```

Le code ci-dessus vous donnerait la figure suivante (dans l'exemple, il s'agit de la sortie pdf, mais comme le tableau est en markdwon, vous pourriez également le convertir en html ou en word).

À partir de là - et en lisant le code d'autres personnes - vous pouvez comprendre comment manipuler le texte pour générer le tableau que vous voulez et créer des fonctions plus personnalisées.