-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.Rmd
1864 lines (1291 loc) · 60.3 KB
/
index.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
title: "Produire des documents reproductibles avec R Markdown"
subtitle: "Partager code et documentation"
author:
- "Ronan Ysebaert, Timothée Giraud, Nicolas Lambert - UMS RIATE"
- "École thématique CNRS Sciences de l'information géographique reproductibles - 2021-06-27 (Saint Pierre d'Oléron)"
date: "Dernière mise à jour: `r Sys.Date()`"
output:
xaringan::moon_reader:
self_contained: true
css: ["default", "css/styles.css", "css/rutgers-tidyverse.css","css/rutgers-fonts_og.css"]
lib_dir: libs
nature:
highlightStyle: github
highlightLines: true
highlightSpans: true
countIncrementalSlides: false
ratio: "16:9"
seal: true
editor_options:
chunk_output_type: console
---
```{r setup, include=FALSE}
options(htmltools.dir.version = FALSE, crayon.enabled = TRUE)
knitr::opts_chunk$set(cache = TRUE,
fig.align='center',
message = FALSE,
warning = TRUE)
# install.packages("devtools")
# devtools::install_github("gadenbuie/countdown")
# devtools::install_github("mitchelloharawild/icons")
library(countdown)
library(icons)
#download_fontawesome()
```
## Objectifs
### Éléments théoriques
- Initiation au literate programming avec R Markdown.
- Bonnes pratiques en matière de reproductibilité et documentation de méthodes.
- Fournir des ressources de référence pour approfondir l'apprentissage.
- *DoItYourSelf* / *Self gratification*.
<br>
### Déroulé
.pull-left[
[Partie 1 - Literate programming ?](#part1)
[Partie 2. Initier un projet R Markdown avec RStudio](#part2)
[Partie 3. La syntaxe Markdown](#part3)
]
.pull-right[
[Partie 4. Bonnes pratiques (code)](#part4)
[Partie 5. Jouer du code dans du R Markdown](#part5)
]
---
## L'atelier - 2 possibilités en fonction de votre niveau de pratique de R
.pull-left[
### Débutant
Mobiliser un jeu de données disponible avec R (cars).
]
.pull-right[
### Confirmé
Caractériser l'environnement géographique des centres de vacances CNRS
```{r, echo = FALSE, message = FALSE, warning = FALSE, fig.height = 5, fig.width= 7}
library(sf) # Manipulation de données spatiales
library(mapsf) # Représentations cartographiques
# Géolocalisation des centres
cent <- read.csv(file = "data/cnrs.csv")
cnrs <- st_as_sf(cent, coords = c("longitude", "latitude"), crs = 4326)
cnrs <- st_transform(cnrs, 2154)
# France
fr <- st_read(dsn = "data/fr.gpkg", layer = "fr", quiet = TRUE)
# Et cartographie
par(mar = c(0,0,0,0))
mf_theme("nevermind")
mf_map(fr, border = NA)
mf_map(cnrs, bg = "red", pch = 21, cex = 2, add = T)
mf_label(x = cnrs, var = "lieu", halo = TRUE, pos = 1,
overlap = FALSE, lines = FALSE, bg = "white", cex = 1)
mf_layout(title = "Les villages du CNRS",
credits = "Ecole Thématique SIG-R, RIATE, 2021", arrow = FALSE)
```
]
---
## L'atelier - 2 possibilités en fonction de votre niveau de pratique de R
.pull-left[
### Débutant
Mobiliser un jeu de données disponible avec R (cars).
]
.pull-right[
### Confirmé
3 représentations cartographiques possibles (population, pollution lumineuse, équipements touristiques à proximité)
```{r, echo = FALSE, message = FALSE, warning = FALSE, fig.height = 5, fig.width= 7}
# Import libraries
library(sf)
library(mapsf)
# Data import
com <- st_read(dsn = paste0("data/oleron.gpkg"), layer = "com", quiet = TRUE)
buf <- st_read(dsn = paste0("data/oleron.gpkg"), layer = "cnrsBuf", quiet = TRUE)
# Cartography - Municipal population
mf_map(buf, col = "lightblue", border = NA) # Analysis perimeter
mf_map(com, col = "white", add = TRUE) # Display muncipalities
mf_map(com, type = "prop", var = "POP_2019", leg_pos = "topleft", col = "grey34",
border = "white", leg_title = "Population 2019") # Map
mf_map(buf, col = NA, lwd = 2, add = TRUE) # Analysis perimeter contour
# Order higher values and display them
com <- com[order(com$POP_2019, decreasing = TRUE),]
mf_label(x = com[1:5,], var = "LAU_NAME", halo = TRUE, overlap = FALSE,
lines = FALSE, bg = "white") # Label des 5 communes les plus peuplées
# Map layout
mf_layout(title = paste0(round(sum(com$POP_2019),-2),
" habitants dans les bourgs des environs"),
credits = paste0("Ecole Thématique SIG-R, RIATE, 2021\n",
"Source : Eurostat - GISCO, 2021"), arrow = FALSE)
```
]
---
name: part1
class: inverse, center, middle
# Partie 1 - Literate programming ?
---
## Literate programming ?
**Paradigme de programmation** qui consiste à associer ensemble du code source (pour les ordinateurs) à de la documentation (pour les humains).</p>
- Un processus d'explication de la pensée : *Expliquer à des êtres humains ce que nous voulons que l'ordinateur fasse* ([Knuth, 1970](https://www-cs-faculty.stanford.edu/~knuth/lp.html)).
- Des programmes qui gagnent en qualité : une explication ininterrompue de la logique, à la manière d'un essai.
- Rend les mauvaises décisions de conception plus évidentes (détails souvent omis dans le code source).
- Permet de reprendre des analyses ultérieurement sans se perdre, même longtemps après.
- Orienté vers la transmission et le partage de connaissance (tutoriels, manuels).
Un gain général en **reproductibilité** de la démarche et en **ouverture** des méthodes scientifiques.
---
## Literate programming ?
.pull-left-c[
Associe un langage de programmation à un langage de balisage léger, dans un environnement de développement ou un document.
Premier environnement de literate programming : WEB (1981), combinaison de Pascal et TeX.
Une application sur l'analyse des nombres premiers.
]
.pull-right-c[
.leg-fig[
Présentation du système de documentation *WEB* par [Donald E. Knuth, Computer Journal (1984)](http://literateprogramming.com/knuthweb.pdf)
]
]
---
## Plusieurs solutions existent
| Nom | Langage supporté | Langage de balisage | Date de création |
|----------------------|-----------------------|---------------------------------------------------|------------------|
| [WEB](http://infolab.stanford.edu/pub/cstr/reports/cs/tr/83/980/CS-TR-83-980.pdf) | Pascal | TeX | 1981 |
| [CWEB](http://tug.ctan.org/info/knuth/cwebman.pdf) | C et C++ | TeX, LaTeX | 1987 |
| [Sweave](https://rpubs.com/YaRrr/SweaveIntro) | R | PDF | 2002 |
| [Knitr](https://github.com/yihui/knitr/releases/download/doc/knitr-manual.pdf) | R | LaTeX, PDF, LyX, HTML, Markdown, AsciiDoc, | 2012 |
| [R Markdown](https://rmarkdown.rstudio.com/) | R, Python, Julia, SQL | Markdown | 2014 |
| [Jupiter Notebook](https://jupyter-notebook.readthedocs.io/en/stable/) | Python (kernel de défaut) | Markdown | 2014 |
| [Observable](https://observablehq.com/@observablehq/how-observable-runs?collection=@observablehq/overview) | JavaScript (librairie D3) | Markdown / LaTeX | 2018 |
--
Leur usage dépend...
.pull-left-c[
- Du langage de programmation supporté.
- De l'usage de la communauté.
- De la variété des formats de sortie proposés.
]
.pull-right-c[
- Des évolutions technologiques.
- De l'intégration dans un environnement de développement intégré (IDE).
]
---
## R Markdown
.pull-left-c[
Format de document initié en 2012 par **Yihui Xie** avec [knitr](https://github.com/yihui/knitr/releases/download/doc/knitr-manual.pdf) puis étendu dans le package [rmarkdown](https://cran.r-project.org/web/packages/rmarkdown/index.html) en 2014. Fait aujourd'hui référence dans l'écosystème de R.
Plusieurs objectifs :
- Compiler des documents R Markdown dans différents formats de sortie : PDF, HTML, Word.
- Pouvoir jouer du code R dans la documentation.
- Produire des sorties interactives (dahshboards) et des sorties de document "attractives".
- Produire facilement des manuels, sites Web.
]
.pull-right-c[
.leg-fig[
Présentations de *Yihui Xie* sur [R Markdown](https://vimeo.com/94181521) et ses [origines](http://datascience.la/yihui-xie-the-user-2014-interview/)
]
]
---
## R Markdown
`rmarkdown` repose sur une **large communauté d'utilisateurs et de développeurs** :
- En évolution constante (Yihui Xie est développeur logiciel à RStudio).
- Très bien documenté, des exemples clé en main, des modèles de mise en page (*templates*)
- Recours important à `rmarkdown` par d'autres packages R.
```{r, echo= FALSE, message=FALSE}
library(tools)
library(dplyr)
library(stringr)
library(purrr)
library(cranlogs)
library(kableExtra)
pdb <- tools:::CRAN_package_db()
# Package and indicators of interest
pack <- c("rmarkdown", "knitr", "bookdown", "rticles", "blogdown", "xaringan")
meta_data <- pdb[, c(1,2, 46, 5, 17, 60, 61, 63)]
meta_data <- meta_data[meta_data$Package %in% pack,]
names(meta_data) <- c("Package","Version", "Maintainer", "Import", "AutNB", "RevDepends", "RevImports", "RevSuggest")
# CLEAN THE AUTHOR'S FIELD
# Function to remove all text between two brackets
clean <- function(x){
gsub("\\[[^]]*]", "",x)
}
# Function to remove line breaks
clean2 <- function(x){
gsub("[\r\n]", "", x)
}
# Clean Author's field
meta_data$AutNB <- meta_data$AutNB %>% map(clean) %>% map(clean2)
rm_na <- function(x){
list(na.omit(unlist(x)))
}
# Process the fields (aggregate number)
c_dat1 <- seq_len(nrow(meta_data)) %>%
map_df(~{
meta_data[.x, ] %>%
select(-Package,-Version,-Maintainer) %>%
map_df(~ifelse(is.na(.x), 0, length(str_split(.x, ",")[[1]]))) %>%
mutate(Package = meta_data$Package[.x])
}) %>%
select(Package,Import, AutNB, RevDepends, RevImports,RevSuggest)
# Exctract info
c_dat2 <- meta_data[,c(1:3)]
# Downloads
c_dat3 <- cran_downloads(packages = pack, from = "2015-01-01", to = Sys.Date())
c_dat3 <- aggregate(c_dat3[,"count"],
by = list(Down = c_dat3$package),
FUN = sum)
# Output results
output <- cbind(c_dat2, c_dat1[,-1], c_dat3[,-1])
colnames(output)[9] <- "Down"
output <- output[match(pack, output$Package),]
output %>%
kable("html", row.names = FALSE) %>%
kable_styling(font_size = 16)
```
.leg-fig[
**Statistiques liées aux packages de l'environnement R Markdown** (*Import* : packages importés au chargement, *AutNB* : nombre d'auteurs, *RevDepends* : autres packages qui dépendent du package, *RevImports* : autres packages qui importent des fonctions du package, *RevSuggest* : autres packages qui suggèrent l'usage du package, *Down* : téléchargements depuis le 1er janvier 2015)
]
---
## Repose sur...
.pull-left-c[
- **[Markdown](https://www.markdownguide.org/getting-started/)**, un langage de balisage léger reconnu pour sa simplicité (John Gruber et Aaron Swartz, 2004)
- **R Markdown** : une variation du markdown spécifique à R et qui permet d'incorporer du code et de l'exécuter dans des *chunks*. C'est aussi un package.
- **knitr** : un package qui interprète le code (R/Python/Julia) contenu dans les chunks *chunks* ([Yihui Xie](https://github.com/yihui/knitr/releases/download/doc/knitr-manual.pdf))
- **Pandoc** : Un logiciel qui convertit le markdown (faiblement structuré) en langage balisé (fortement structuré). Installé automatiquement avec RStudio.
]
.pull-right-c[
.leg-fig[
[Source : FinistR2018](https://stateofther.github.io/finistR2018/atelier3_advancedrmd.html)
]
]
---
## Un document R Markdown type
Un fichier R Markdown contient 3 parties essentielles.
.pull-left.c[
- Des **métadonnées** associées au document (YAML - Yet Another Markup Language) : configuration des fichiers de sortie (format, css, bibliographie, métadonnées auteur, date de création, etc.)
- Du **texte**, qui décrit le cheminement de pensée : langage Markdown.
- Des **blocs de code** structurés, pour rendre reproductible l'analyse.
Ces trois éléments sont paramétrables pour produire des documents uniques.
]
.pull-right-c[
<p align="center"><img src="fig/rmardown.PNG" height= 300px width = 600px/></p>
.leg-fig[
[Source : RStudio](https://rmarkdown.rstudio.com/lesson-1.html)
]
]
---
## Des possibilités de sorties mutliples
.fig[
]
.leg-fig[
[Source : RStudio](https://rmarkdown.rstudio.com/lesson-1.html)
]
---
## Document R Markdown
Le modèle de document R Markdown standard de R Studio.
.pull-left-c[
<p align="left"><img src="fig/rmadkown_document_input.PNG" height= 450px width = auto/></p>
]
.pull-right-c[
<p align="right"><img src="fig/rmadkown_document_output.PNG" height= 450px width = auto/></p>
]
---
## Présentations
Le modèle de présentation R Markdown standard de R Studio ([`ioslides_presentation`](https://bookdown.org/yihui/rmarkdown/ioslides-presentation.html)).
.pull-left-c[
]
.pull-right-c[
]
---
## Présentations
Des packages dédiés à la réalisation de présentations, comme [`xaringan`](https://bookdown.org/yihui/rmarkdown/xaringan.html) ou [`revealjs`](https://github.com/rstudio/revealjs)
.pull-left-c[
.fig[
<p align="center"><img src="fig/xaringan.PNG" width="100%" height="100%"/></p>
]
.leg-fig[
[Présentation xaringan, Xie, 2021](https://slides.yihui.org/xaringan/#1)
]
]
.pull-right-c[
.fig[
<p align="center"><img src="fig/reveal-js.png" width="200%" height="200%"/></p>
]
.leg-fig[
[Create Stunning Presentations on the Web](https://revealjs.com/)
]
]
---
## Bookdown
Un [package](https://bookdown.org/yihui/rmarkdown/books.html) dédié à l'écriture de rapports et livres numériques longs. Repose sur la compilation de documents R Markdown.
.pull-left-c[
<p align="center"><img src="fig/cover_bookdown1.png" height= 350px width = auto/></p>
]
.pull-right-c[
<p align="center"><img src="fig/cover_bookdown2.png" height= 350px width = auto/></p>
]
.leg-fig[
[RMarkdown Cookbook (Xie, Dervieux, Riederer, 2021)](https://bookdown.org/yihui/rmarkdown-cookbook/)
]
---
## Bookdown
Un [package](https://bookdown.org/yihui/rmarkdown/books.html) dédié à l'écriture de rapports et livres numériques longs. Repose sur la compilation de documents R Markdown.
.pull-left-c[
<p align="center"><img src="fig/cover_bookdown3.png" height= 350px width = auto/></p>
]
.pull-right-c[
<p align="center"><img src="fig/cover_bookdown4.png" height= 350px width = auto/></p>
]
.leg-fig[
[Geocomputation with R (Lovelace, Nowosad, Muenchow, 2019)](https://geocompr.robinlovelace.net/)
]
---
## Rmardown's site generator
.pull-left-c[
<p align="center"><img src="fig/website1.PNG" height= 450px width = auto/></p>
]
.pull-right-c[
Transformer une collection de documents [R Markdown en site Web](https://bookdown.org/yihui/rmarkdown/rmarkdown-site.html). Chaque .Rmd devient une page du site Web.
La configuration de l'affichage de la collection de fichiers HTML s'effectue dans un fichier `_site.yml`.
<br><br><br><br><br><br>
.leg-fig[
Un [site Web](https://rcarto.gitpages.huma-num.fr/centralite/) d'un projet de recherche qui combine préparation des données, analyses et documentations (métadonnées).
]
]
---
## Blogdown
.pull-left-c[
<p align="center"><img src="fig/website2.PNG" height= 450px width = auto/></p>
]
.pull-right-c[
Un [package](https://github.com/rstudio/blogdown) dédié à la génération de site Webs :
- Utilise par défaut un générateur de sites Web open source, [Hugo](https://gohugo.io/), qui propose de nombreux [thèmes](https://themes.gohugo.io/).
- Possibilité d'organiser le contenu du site Web en sous-répertoires.
<br><br><br><br>
.leg-fig[
[Rzine](https://rzine.fr/collection/#publi_rzine), un site Web dédié au partage de ressources sur la pratique de R en sciences sociales.
]
]
---
## Journals
Le package [rticles](https://github.com/rstudio/rticles) intègre les modèles éditoriaux de plusieurs revues (sortie Rmd, pdf, TeX document). Recquiert l'installation d'outils permettant de compiler du LaTex, comme [TinyTex](https://yihui.org/tinytex/r/). Nécessite possiblement l'installation de packages [LaTex](https://bookdown.org/yihui/rmarkdown-cookbook/install-latex-pkgs.html) manquants (quelques [tips](https://github.com/yihui/tinytex/issues/210)).
<img src="fig/journals.PNG" height="350"><img src="fig/journals_2.PNG" height="350"><img src="fig/journals_3.PNG" height="350">
.leg-fig[
Une trentaine de revues et éditeurs référencés, dont [The R Journal](https://journal.r-project.org/) et [PLOS](https://plos.org/#journals). Ouvert aux contributions
]
---
name: part2
class: inverse, center, middle
# Partie 2 - Créer un projet R Markdown avec RStudio
---
## Préparer son espace de travail
RStudio propose d'organiser son travail en **projet** (File > New Project). L’idée principale consiste à réunir tous les fichiers / documents relatifs à un même projet dans un **répertoire dédié**.
.pull-left-c[
<p align="center"><img src="fig/New_project.png" width="350"/></p>
]
.pull-right-c[
A l'ouverture du projet :
- Le nom du projet est affiché à côté de l'icône projet.
- Une nouvelle session de R est exécutée.
- Le répertoire de travail de R est défini comme étant le répertoire du projet.
- Les objets créés (et sauvegardés dans le fichier .RData) sont chargés en mémoire.
- Les scripts ouverts lors d'une précédente séance de travail sont automatiquement ouverts.
]
Facilite le **travail discontinu**, améliore la **portabilité** et garantie la **reproductibilité** de son travail.
---
## Préparer son espace de travail
Disposer d'une organisation de dossiers et de fichiers claire et cohérente facilite l'appropriation du répertoire de travail par d'autres.
.pull-left-c[
**Organiser son espace de travail**
- Un R Project à la racine.
- Un dossier dédié au stockage des données.
- Un dossier qui contient les figures.
- ...
]
.pull-right-c[
<img src="fig/folder_orga.PNG" width="400"/></img>
]
---
## Initier un projet R Markdown dans RStudio
RStudio propose l'import de modèles [R Markdown](https://rmarkdown.rstudio.com/) (File > New File > R Markdown).
<p align="center"><img src="fig/rmarkdown3.PNG" height="400"/></p>
---
## Modèles additionnels
Une multitude ! Avec les packages [`rmdformats`](https://github.com/juba/rmdformats), [`prettydoc`](https://prettydoc.statr.me/themes.html) et [`tufte`](https://github.com/rstudio/tufte) (documents HTML), [`xaringan`](https://github.com/yihui/xaringan) et [`revealjs`](https://github.com/hakimel/reveal.js/) (présentations), [`rticles`](https://github.com/rstudio/rticles) (revues scientifiques), [`pagedown`](https://github.com/rstudio/pagedown) (posters, pages illustrées), [`flexdashboard`](https://pkgs.rstudio.com/flexdashboard/) et [`learnr`](https://rstudio.github.io/learnr/) (dashboards, tutoriels)...
<p align="center"><img src="fig/rmarkdown_templates.PNG" height="400"/></p>
---
## Des modèles paramétrables
Possibilité d'ajouter des paramètres dans les métadonnées du document.
.pull-left-c[
```yaml
---
title: Un R Markdown formidable en gestation
author: Un auteur qui semble maitriser cette technologie
date: 27 juin 2021
output:
html_document:
theme: united
toc: true
number_sections: true
---
```
]
.pull-right-c[
- **title, author, date** : Par défaut à la création d'un R Markdown
- **output** : type de sortie (`html_document` ou `ioslides_presentation`, ou modèles issus de certains packages comme `rmdformats::robobook:`)
- **theme** : [12 thèmes](https://www.datadreaming.org/post/r-markdown-theme-gallery/) additionnels pour personnaliser graphiquement son document.
- **toc** : table des matières
- **number_sections** : numéros de sections
- ... Et beaucoup d'autres options, présentées [ici](https://bookdown.org/yihui/rmarkdown/html-document.html).
]
---
## "Tricoter" son R Markdown
.pull-left-c[
Le R Markdown est exporté en .HTML (ou .pdf, ou .doc) en réalisant un **`knit`** du .Rmd.
Cette action :
- Interprète les métadonnées du document (YAML)
- Transforme la syntaxe Markdown dans un balisage interprété par le fichier de sortie désiré.
- Exécute les `chunks` (lire, afficher, exécuter ou non le code inclut dans le .Rmd).
]
.pull-right-c[
.leg-fig[
Réaliser un `Knit` du R Markdown dans R Studio.
]
]
---
## "Tricoter" son R Markdown
.pull-left-c[
Le R Markdown est exporté en .HTML (ou .pdf, ou .doc) en réalisant un **`knit`** du .Rmd.
Cette action :
- Interprète les métadonnées du document (YAML)
- Transforme la syntaxe Markdown dans un balisage interprété par le fichier de sortie désiré.
- Exécute les `chunks` (lire, afficher, exécuter ou non le code inclut dans le .Rmd).
]
.pull-right-c[
Ceci...
]
---
## "Tricoter" son R Markdown
.pull-left-c[
Le R Markdown est exporté en .HTML (ou .pdf, ou .doc) en réalisant un **`knit`** du .Rmd.
Cette action :
- Interprète les métadonnées du document (YAML)
- Transforme la syntaxe Markdown dans un balisage interprété par le fichier de sortie désiré.
- Exécute les `chunks` (lire, afficher, exécuter ou non le code inclut dans le .Rmd).
]
.pull-right-c[
Génère cela
]
---
class: action
## A vous de jouer !
.pull-left-c[
###Débutant
**Créez un document R Markdown depuis un modèle**
- Créer un dossier pour l'atelier.
- Créez un document R Markdown (*file > New File > R Markdown > Document*).
- Enregistrez le fichier .Rmd dans ce dossier.
- Renseignez les métadonnées du .Rmd (nom, date).
- Knitez le document.
- Testez plusieurs thèmes en modifiant les métadonnées (`cerulean`, `cosmo`, `flatly`, `journal`,
`lumen`, `paper`, `readable`, `sandstone`)
```yaml
---
title: Un R Markdown formidable en gestation
author: Un auteur qui semble maitriser cette technologie
date: 27 juin 2021
output:
html_document:
* theme: united
toc: true
number_sections: true
---
```
]
.pull-right-c[
###Confirmé
**Préparez un espace de travail reproductible pour l'analyse**
- Téléchargez et décompressez les données associées à l'exercice : [bit.ly/2U0KppL](https://bit.ly/2U0KppL)
- Choisissez un modèle de document issu du package `rmdformats`.
- Nommez le .Rmd **index**, le placer à la racine du dossier précédemment téléchargé.
- Renseignez les métadonnées du .Rmd (YAML), et jouez avec les [options](https://bookdown.org/yihui/rmarkdown/html-document.html)
]
`r countdown(minutes = 10, seconds = 00, top = 0)`
---
name: part3
class: inverse, center, middle
# Partie 3. La syntaxe Markdown
---
## Markdown
Un langage de balisage léger largement utilisé dans les blogs, forum, outils collaboratifs (OpenStreetMap ou GitHub utilisent des dérivés du [Markdown](https://www.markdownguide.org/tools/) pour faciliter les échanges entre les utilisateurs, par exemple).
<p align="center"><img src="fig/markdown.PNG" height="400"/></p>
---
## En-têtes
Le signe **`#`** introduit les niveaux de titres (jusqu'à 5 niveaux).
.pull-left[
.inline-c[#Europe] devient
.out-t[
# Europe
]
.inline-c[## France] devient
.out-t[
## France
]
]
.pull-right[
.inline-c[### Nouvelle-Aquitaine] devient
.out-t[
### Nouvelle-Aquitaine
]
.inline-c[#### Charentes-Maritimes] devient
.out-t[
#### Charentes-Maritimes
]
.inline-c[##### Saint-Pierre d'Oléron] devient
.out-t[
##### Saint-Pierre d'Oléron
]
]
---
## Accentuations
Les signes **`*`** et **`_`** gèrent les accentuations.
<span style="background-color: #e5e5e5; border-radius: 3px; padding: 4px; font-family: 'Source Code Pro', 'Lucida Console', Monaco, monospace;">**Un mot important**</span> devient .out-t[**Un mot important**]
<span style="background-color: #e5e5e5; border-radius: 3px; padding: 4px; font-family: 'Source Code Pro', 'Lucida Console', Monaco, monospace;">*Une citation*</span> devient .out-t[*Une citation*]
<span style="background-color: #e5e5e5; border-radius: 3px; padding: 4px; font-family: 'Source Code Pro', 'Lucida Console', Monaco, monospace;">***Une citation importante***</span> devient .out-t[***Une citation importante***]
---
## Listes
Les lignes introduites par **`*`**, **`+`** ou **`-`** génèrent des listes.
```{r eval=FALSE}
- books
- articles
- reports
```
.out-t[
- books
- articles
- reports
]
---
## Tables
Créer des tables (syntaxe simple)
<br>
.pull-left[
```{r eval=FALSE, tidy=FALSE}
Centered Right-Aligned
---------------- ----------------
First cell First cell
Second cell Second cell
Third cell Third cell
#<<
: A hand-made table with R Markdown
#<<
```
]
.pull-right[
<center>Table 1: A hand-made table with R Markdown</center>
<br>
| Centered | Right-Aligned |
|:----------------------------------------------: | --------------------------------------------------: |
| First cell | First cell |
| Second cell| Second cell |
| Third cell | Third cell |
]
---
## Tables
[Tables Generator](https://www.tablesgenerator.com/) est utile pour mettre en forme sa table et la transformer en diverses syntaxes de balisage, dont Markdown.
<p align="center"><img src="fig/table_generator.PNG" height="400"/></p>
---
## Liens
Associer du texte à des URL
<span style="background-color: #e5e5e5; border-radius: 3px; padding: 4px; font-family: 'Source Code Pro', 'Lucida Console', Monaco, monospace;">[La Vieille Perrotine](https://www.caes.cnrs.fr/sejours/la-vieille-perrotine/)</span> devient .out-t[[La Vieille Perrotine](https://www.caes.cnrs.fr/sejours/la-vieille-perrotine/)]
<span style="background-color: #e5e5e5; border-radius: 3px; padding: 4px; font-family: 'Source Code Pro', 'Lucida Console', Monaco, monospace;"><https://www.caes.cnrs.fr/sejours/la-vieille-perrotine/></span> devient .out-t[<https://www.caes.cnrs.fr/sejours/la-vieille-perrotine/>] aussi
--
Associer une adresse mail
<span style="background-color: #e5e5e5; border-radius: 3px; padding: 4px; font-family: 'Source Code Pro', 'Lucida Console', Monaco, monospace;">[me contacter](mailto:[email protected])</span><sup></sup> devient .out-t[[me contacter](mailto:[email protected])]
<span style="background-color: #e5e5e5; border-radius: 3px; padding: 4px; font-family: 'Source Code Pro', 'Lucida Console', Monaco, monospace;"><[email protected]></span> devient .out-t[<[email protected]>]
---
## Image
``
---
## Limites de Markdown
Il est parfois nécessaire d'introduire du code html pour dimensionner des éléments graphiques sur mesure.
`<p align="center"><img src="fig/boyard.jpg" height="60%" width="60%"/></p>`
<p align="center"><img src="fig/boyard.jpg" height="60%" width="60%"/></p>
---
class: action
## A vous de jouer !
**Enrichissez le .Rmd précédemment généré avec de la syntaxe Markdown**
.pull-left[
### Débutant
- **Titres**. Rajouter 3 titres de niveau 2 : *Description du jeu de données*, *Résumé statistique*, *Représentation graphique*
- **Contenu**. Rappeler dans la première partie (syntaxe Markdown) l'origine du jeu de données : *Proposé par McNeil en 1977, ce jeu de données délivre la vitesse d'une voiture et la distance requise pour s'arrêter dans les années 1920*.
- Un élément de texte en gras, un élément en italique.
]
.pull-right[
###Confirmé
- **Titres**. 4 titres de niveau 2 : *Sources*, *Import des données*, *La population dans les environs*, *Session info*.
- **Figures **. Incorporez l'image du centre CNRS choisi (dossier fig), adaptez sa taille.
- **Table**. Créez une table dans la première partie (Sources) rappelant les sources mobilisées dans l'exercice (data-sources.png)
]
`r countdown(minutes = 10, seconds = 00, top = 0)`
---
name: part4
class: inverse, center, middle
# Partie 4. Bonnes pratiques (code)
---
## Un code exécutable et lisible
Un code **propre** et **fonctionnel** peut être lu et amélioré par un autre auteur (ou par soi-même) longtemps après.
**Un code fonctionnel**
- S'assurer au préalable que son code fonctionne sans erreur.
- N'est pas redondant : pour des opérations répétitives, créer des fonctions ou des boucles.
Un code [bien écrit](https://dl.leneveu.fr/public/Coder_Proprement.pdf) est :
- [Bien structuré](https://www.r-bloggers.com/2018/09/r-code-best-practices/).
- Facile à lire, par soi-même et par les autres (indentation, noms d'objets)
- Organisé de façon logique (simplicité).
- Explicite et montre les intentions du développeur (commentaires).
- A jour (utiliser la dernière version des packages, si ce n'est pas le cas, l'expliquer).
---
## Un code clair et lisible
.pull-left[
Une carte de la population communale 30 km autour du centre CNRS de Saint-Pierre d'Oléron.
```{r, eval = TRUE, echo = FALSE, warning = FALSE, message = FALSE, fig.height = 5}