Associated Material

Module: Module 06 - Communicate

Readings:

What is RMarkdown

There are three main components to an RMarkdown document

  1. The YAML header which is surrounded by ---s and provides information for the compiling process
  2. R code chunks which are surrounded by ```s
  3. Text which can be formatted using the Markdown language.

A reference guide of RMarkdown syntax can be found through Help -> Cheat Sheets -> R Markdown Reference Guide in the RStudio menu.

Example Rmd

Create your own RMarkdown document now from the template. To do this go File -> New File -> R Markdown.

Knitting

“Knit” or compile the document using the knit button or Ctrl + Shift + K.


Markdown syntax

Refer to the RMarkdown Reference Guide


Code Chunks

Code chunks look like:

```{r}
1 + 2
```
  • Code chunks are executed as part of the document “knitting” and the code and output embedded in the document

  • Be aware of the working directory (don’t use setwd()). Ideally use the here package to manage paths.


Images, Figures, and Tables

  • Images can be included though markdown, or by using the include_graphics() from knitr in a code chunk - the latter provides more options for customising for size/position.

  • Figures are created from code chunks and chunk options are used to control size/position

  • Tables can be manually created using the markdown syntax or created automatically from your data using the kable() from knitr.

Further customising of kable tables can be done with the kableExtra package.


Citations

Citations can be inserted into an RMarkdown document. This document from RStudio goes through how to do it

LS0tCnRpdGxlOiAiWm9vbSBOb3RlcyAwNjogQ29tbXVuaWNhdGluZyBEYXRhIgpkYXRlOiAiU2VtZXN0ZXIgMiwgMjAyMiIKb3V0cHV0OgogIGh0bWxfZG9jdW1lbnQ6CiAgICB0b2M6IHRydWUKICAgIHRvY19mbG9hdDogdHJ1ZQogICAgdG9jX2RlcHRoOiAzCiAgICBjb2RlX2Rvd25sb2FkOiB0cnVlCiAgICBjb2RlX2ZvbGRpbmc6IHNob3cKLS0tCgpgYGB7ciBzZXR1cCwgaW5jbHVkZT1GQUxTRX0KbGlicmFyeShrbml0cikKCmtuaXRyOjpvcHRzX2NodW5rJHNldCgKICBjb21tZW50ID0gIiM+IiwKICBmaWcucGF0aCA9ICJmaWd1cmVzLzA2LyIsICMgdXNlIG9ubHkgZm9yIHNpbmdsZSBSbWQgZmlsZXMKICBjb2xsYXBzZSA9IFRSVUUsCiAgZWNobyA9IFRSVUUKKQoKCmBgYAoKPiAjIyMjIEFzc29jaWF0ZWQgTWF0ZXJpYWwKPgo+IE1vZHVsZTogW01vZHVsZSAwNiAtIENvbW11bmljYXRlXSgwNi1jb21tdW5pY2F0ZS5odG1sKQo+Cj4gUmVhZGluZ3M6Cj4KPiAtICAgW1IgZm9yIERhdGEgU2NpZW5jZSAtIENoYXB0ZXIgMjddKGh0dHBzOi8vcjRkcy5oYWQuY28ubnovci1tYXJrZG93bi5odG1sKQo+IC0gICBbUiBmb3IgRGF0YSBTY2llbmNlIC0gQ2hhcHRlciAyOV0oaHR0cHM6Ly9yNGRzLmhhZC5jby5uei9yLW1hcmtkb3duLWZvcm1hdHMuaHRtbCkKPiAtICAgW1JlZmVyZW5jZTogUk1hcmtkb3duIC0gdGhlIGRlZmluaXRpdmUgZ3VpZGVdKGh0dHBzOi8vYm9va2Rvd24ub3JnL3lpaHVpL3JtYXJrZG93bi8pCj4gLSAgIFtSTWFya2Rvd24gUmVmZXJlbmNlIEd1aWRlXShodHRwczovL3d3dy5yc3R1ZGlvLmNvbS93cC1jb250ZW50L3VwbG9hZHMvMjAxNS8wMy9ybWFya2Rvd24tcmVmZXJlbmNlLnBkZikKCiMjIFdoYXQgaXMgUk1hcmtkb3duCgpUaGVyZSBhcmUgdGhyZWUgbWFpbiBjb21wb25lbnRzIHRvIGFuIFJNYXJrZG93biBkb2N1bWVudAoKMS4gIFRoZSAqKllBTUwqKiBoZWFkZXIgd2hpY2ggaXMgc3Vycm91bmRlZCBieSBgLS0tYHMgYW5kIHByb3ZpZGVzIGluZm9ybWF0aW9uIGZvciB0aGUgY29tcGlsaW5nIHByb2Nlc3MKMi4gIFIgY29kZSAqKmNodW5rcyoqIHdoaWNoIGFyZSBzdXJyb3VuZGVkIGJ5IGBgYGAgYGBgIGBgYGBzCjMuICBUZXh0IHdoaWNoIGNhbiBiZSBmb3JtYXR0ZWQgdXNpbmcgdGhlIE1hcmtkb3duIGxhbmd1YWdlLgoKCkEgcmVmZXJlbmNlIGd1aWRlIG9mIFJNYXJrZG93biBzeW50YXggY2FuIGJlIGZvdW5kIHRocm91Z2ggYEhlbHBgIC0+IGBDaGVhdCBTaGVldHNgIC0+IGBSIE1hcmtkb3duIFJlZmVyZW5jZSBHdWlkZWAgaW4gdGhlIFJTdHVkaW8gbWVudS4KCiMjIyBFeGFtcGxlIFJtZAoKQ3JlYXRlIHlvdXIgb3duIFJNYXJrZG93biBkb2N1bWVudCBub3cgZnJvbSB0aGUgdGVtcGxhdGUuIFRvIGRvIHRoaXMgZ28gYEZpbGVgIC1cPiBgTmV3IEZpbGVgIC1cPiBgUiBNYXJrZG93bmAuCgojIyMgS25pdHRpbmcKCiJLbml0IiBvciBjb21waWxlIHRoZSBkb2N1bWVudCB1c2luZyB0aGUgYGtuaXRgIGJ1dHRvbiBvciA8a2JkPkN0cmw8L2tiZD4gKyA8a2JkPlNoaWZ0PC9rYmQ+ICsgPGtiZD5LPC9rYmQ+LgoKXAoKIyMgTWFya2Rvd24gc3ludGF4CgpSZWZlciB0byB0aGUgW1JNYXJrZG93biBSZWZlcmVuY2UgR3VpZGVdKGh0dHBzOi8vd3d3LnJzdHVkaW8uY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDE1LzAzL3JtYXJrZG93bi1yZWZlcmVuY2UucGRmKQoKXAoKIyMgQ29kZSBDaHVua3MKCkNvZGUgY2h1bmtzIGxvb2sgbGlrZToKCmBgYHtyIGVjaG8gPSBGQUxTRSwgY29tbWVudCA9ICIifQpjYXQoaHRtbHRvb2xzOjppbmNsdWRlVGV4dCgic2NyaXB0cy9jb2RlX2NodW5rLlJtZCIpKQpgYGAKCi0gQ29kZSBjaHVua3MgYXJlIGV4ZWN1dGVkIGFzIHBhcnQgb2YgdGhlIGRvY3VtZW50ICJrbml0dGluZyIgYW5kIHRoZSBjb2RlIGFuZCBvdXRwdXQgZW1iZWRkZWQgaW4gdGhlIGRvY3VtZW50CgotIEJlIGF3YXJlIG9mIHRoZSB3b3JraW5nIGRpcmVjdG9yeSAoZG9uJ3QgdXNlIGBzZXR3ZCgpYCkuIElkZWFsbHkgdXNlIHRoZSBgaGVyZWAgcGFja2FnZSB0byBtYW5hZ2UgcGF0aHMuCgpcCgojIyBJbWFnZXMsIEZpZ3VyZXMsIGFuZCBUYWJsZXMKCi0gSW1hZ2VzIGNhbiBiZSBpbmNsdWRlZCB0aG91Z2ggbWFya2Rvd24sIG9yIGJ5IHVzaW5nIHRoZSBgaW5jbHVkZV9ncmFwaGljcygpYCBmcm9tIGBrbml0cmAgaW4gYSBjb2RlIGNodW5rIC0gdGhlIGxhdHRlciBwcm92aWRlcyBtb3JlIG9wdGlvbnMgZm9yIGN1c3RvbWlzaW5nIGZvciBzaXplL3Bvc2l0aW9uLgoKLSBGaWd1cmVzIGFyZSBjcmVhdGVkIGZyb20gY29kZSBjaHVua3MgYW5kIGNodW5rIG9wdGlvbnMgYXJlIHVzZWQgdG8gY29udHJvbCBzaXplL3Bvc2l0aW9uCgotIFRhYmxlcyBjYW4gYmUgbWFudWFsbHkgY3JlYXRlZCB1c2luZyB0aGUgbWFya2Rvd24gc3ludGF4IG9yIGNyZWF0ZWQgYXV0b21hdGljYWxseSBmcm9tIHlvdXIgZGF0YSB1c2luZyB0aGUgYGthYmxlKClgIGZyb20gYGtuaXRyYC4KCkZ1cnRoZXIgY3VzdG9taXNpbmcgb2YgYGthYmxlYCB0YWJsZXMgY2FuIGJlIGRvbmUgd2l0aCB0aGUgYGthYmxlRXh0cmFgIHBhY2thZ2UuCgpcCgojIyBDaXRhdGlvbnMKCkNpdGF0aW9ucyBjYW4gYmUgaW5zZXJ0ZWQgaW50byBhbiBSTWFya2Rvd24gZG9jdW1lbnQuIFtUaGlzIGRvY3VtZW50IGZyb20gUlN0dWRpb10oaHR0cHM6Ly9yc3R1ZGlvLmdpdGh1Yi5pby92aXN1YWwtbWFya2Rvd24tZWRpdGluZy9jaXRhdGlvbnMuaHRtbCkgZ29lcyB0aHJvdWdoIGhvdyB0byBkbyBpdAo=