• Introduction
    • Learning goals
  • Getting Started
  • Structure of an R Markdown file
    • Header
    • Body text
    • Code chunks
  • Markdown syntax
    • Exercises
  • Graphs and Tables
    • Graphs
    • Tables
    • Statistics
    • Exercise

Introduction

This document is the beginning of a tutorial on using R Markdown to mix prose and code together for creating reproducible scientific documents. This document is adapted from a tutorial that Mike Frank and Chris Hartgerink taught together at SIPS 2017.

In short: R Markdown allows you to create documents that are compiled with code, producing your next scientific paper.

Learning goals

By the end of this tutorial you should:

  • Know what Markdown is and how the syntax works
  • See how to integrate code and data in R Markdown
  • Be able to knit an R Markdown document

Getting Started

Fire up Rstudio and create a new R Markdown file. File > New File > R Markdown. Name the file whatever you’d like. Under “Default Output Formats”, click the radio button next to Word.

If you click on “Knit” (or hit CMD+SHIFT+K on a Mac or CTRL+SHIFT+K on a PC) the R Markdown file will run and generate all results and present you with a PDF file, HTML file, or a Word file. If RStudio requests you to install packages, click yes and see whether everything works to begin with. If you haven’t already, you might be asked to save the file first.

We need that before we teach you more about R Markdown. But you should feel good if you get here already, because honestly, you’re about 80% of the way to being able to write basic R Markdown files. It’s that easy.

Structure of an R Markdown file

An R Markdown file contains several parts. Most essential are the header, the body text, and code chunks.

Body text

The body of the document is where you actually write your reports. This is primarily written in the Markdown format, which is explained in the Markdown syntax section.

The beauty of R Markdown is, however, that you can evaluate R code right in the text. To do this, you start inline code with `r, type the code you want to run, and close it again with a `. Usually, this key is below the escape (ESC) key or next to the left SHIFT button.

For example, if you want to have the result of 48 minus 35 in your text, you type ` r 48-35`, which returns 13. Please note that if you return a value with many decimals, it will also print these depending on your settings (for example, 3.1415927).

Code chunks

In the section above we introduced you to running code inside text, but often you need to take several steps in order to get to the result you need. And you don’t want to do data cleaning in the text! This is why there are code chunks. A simple example is a code chunk loading packages.

First, insert a code chunk by going to Code->Insert code chunk or by pressing CMD+OPTION+I on a Mac or CTRL+ALT+I on a PC. Inside this code chunk you can then type for example, library(ggplot2) and create an object x.

library(ggplot2)

x <- 1 + 1

If you do not want to have the contents of the code chunk put into your document, you include echo=FALSE at the start of the code chunk. We can now use the contents from the above code chunk to print results (e.g., x=2).

These code chunks can contain whatever you need, including tables, and figures (which we will go into more later). Note that all code chunks regard the location of the R Markdown as the working directory, so when you try to read in data use the relative path in.

Markdown syntax

Markdown is one of the simplest document languages around, that is an open standard and can be converted into .tex, .docx, .html, .pdf, etc. This is the main workhorse of R Markdown and is very powerful. You can learn Markdown in five (!) minutes Other resources include http://rmarkdown.rstudio.com/authoring_basics.html, and this cheat sheet.

You can do some pretty cool tricks with Markdown, but these are the basics:

  • It’s easy to get *italic* or **bold**.
  • You can get headings using # heading1 for first level, ## heading2 for second-level, and ### heading3 for third level. Make sure you leave a space after the #!
  • Lists are delimited with * for each entry.
  • You can write links by writing [here's my link](http://foo.com).

If you want a more extensive description of all the potential of Markdown, this introduction to Markdown is highly detailed.

The great thing about Markdown is that it works almost everywhere! Github, OSF, slack, many wikis, and even in text documents it looks pretty good.

Exercises

  1. Outlining using headings is a really great way to keep things organized! Try making a bunch of headings (i.e., first, second, and third level as described above) in your new markdown file, and then recompiling your document.
  2. Add a table of contents. This will involve going to the header of the document (the YAML), and adding some options to the word document bit. You want it to look like this (indentation must be correct):
output: 
  word_document:
    toc: true

Now recompile. Looks nice, right?2

Graphs and Tables

We’re going to want more libraries loaded (for now we’re loading them inline). If you’ve never used these packages before, you might need to install them!

library(knitr)
library(ggplot2)
library(broom)

Graphs

It’s really easy to include graphs, like this one. (Using the mtcars dataset that comes with ggplot2).

qplot(hp, mpg, col = factor(cyl), data = mtcars)

All you have to do is make the plot and it will render straight into the text.

External graphics can also be included, as follows:

knitr::include_graphics("path/to/file")

Tables

There are many ways to make good-looking tables using R Markdown, depending on your display purpose.

  • The knitr package (which powers R Markdown) comes with the kable function. It’s versatile and makes perfectly reasonable tables. It also has a digits argument for controlling rounding.

  • For HTML tables, there is the DT package, which provides datatable – these are pretty and interactive javascript-based tables that you can click on and search in. Not great for static documents though.

  • For APA manuscripts, it can also be helpful to use the xtable package, which creates very flexible LaTeX tables. These can be tricky to get right but they are completely customizable provided you want to google around and learn a bit about tex.

We recommend starting with kable:

kable(head(mtcars), digits = 1)
mpg cyl disp hp drat wt qsec vs am gear carb
Mazda RX4 21.0 6 160 110 3.9 2.6 16.5 0 1 4 4
Mazda RX4 Wag 21.0 6 160 110 3.9 2.9 17.0 0 1 4 4
Datsun 710 22.8 4 108 93 3.9 2.3 18.6 1 1 4 1
Hornet 4 Drive 21.4 6 258 110 3.1 3.2 19.4 1 0 3 1
Hornet Sportabout 18.7 8 360 175 3.1 3.4 17.0 0 0 3 2
Valiant 18.1 6 225 105 2.8 3.5 20.2 1 0 3 1

Statistics

It’s also really easy to include statistical tests of various types.

For this, an option is the broom package, which formats the outputs of various tests really nicely. Paired with knitr’s kable you can make very simple tables in just a few lines of code.

mod <- lm(mpg ~ hp + cyl, data = mtcars)
kable(tidy(mod), digits = 3)
term estimate std.error statistic p.value
(Intercept) 36.908 2.191 16.847 0.000
hp -0.019 0.015 -1.275 0.213
cyl -2.265 0.576 -3.933 0.000

Of course, cleaning these up can take some work. For example, we’d need to rename a bunch of fields to make this table have the labels we wanted (e.g., to turn hp into Horsepower).

We often need APA-formatted statistics. We can compute them first, and then print them inline.

ts <- t.test(mpg ~ am, data = mtcars)

There’s a statistically-significant difference in miles per gallon for cars with automatic vs. manual transmissions (t(18.33)=−3.77, p=0.001).

To insert these stats inline I wrote e.g. round(ts$parameter, 2) inside an inline code block.3

Note that rounding can occasionally get you in trouble here, because it’s very easy to have an output of p=0 when in fact p can never be exactly equal to 0. Nonetheless, this can help you prevent rounding errors and the wrath of statcheck.

Exercise

  1. Using the mtcars dataset, insert a table and a graph of your choice into the document.4

See the tutorial that Mike Frank and Chris Hartgerink taught together at SIPS 2017 for additional content!

  1. Note: to create PDF documents you also need a TeX installation. Don’t know what that is? You probably don’t have it then. More info below.↩︎

  2. Pro-tip: you can specify how deep the TOC should go by adding toc_depth: 2 to go two levels deep↩︎

  3. APA would require omission of the leading zero. papaja::printp() will let you do that, see below.↩︎

  4. If you’re feeling uninspired, try hist(mtcars$mpg).↩︎

---
title: "R Markdown for writing reproducible scientific papers"
author: 'Adapted from work by [Mike Frank](mailto:mcfrank@stanford.edu) and [Chris Hartgerink](mailto:chris@libscie.org)'
date: 
output:
  html_document:
    theme: flatly
    toc: yes
    toc_depth: 2
    toc_float: TRUE
    code_download: TRUE
---


```{r, echo=FALSE}
library(knitr)
opts_chunk$set(echo=TRUE, 
               warning=FALSE, message=FALSE, 
               cache=FALSE)
```

# Introduction

This document is the beginning of a tutorial on using R Markdown to mix prose and code together for creating reproducible scientific documents. This document is adapted from [a tutorial that Mike Frank and Chris Hartgerink taught together at SIPS 2017](https://github.com/mcfrank/rmarkdown-workshop).

In short: R Markdown allows you to create documents that are compiled with code, producing your next scientific paper.

## Learning goals

By the end of this tutorial you should:

* Know what Markdown is and how the syntax works 
* See how to integrate code and data in R Markdown
* Be able to *knit* an R Markdown document

# Getting Started

Fire up Rstudio and create a new R Markdown file. File > New File > R Markdown. Name the file whatever you'd like. Under "Default Output Formats", click the radio button next to Word. 

If you click on "Knit" (or hit `CMD+SHIFT+K` on a Mac or `CTRL+SHIFT+K` on a PC) the R Markdown file will run and generate all results and present you with a PDF file, HTML file, or a Word file. If RStudio requests you to install packages, click yes and see whether everything works to begin with. If you haven't already, you might be asked to save the file first.

We need that before we teach you more about R Markdown. But you should feel good if you get here already, because honestly, you're about 80% of the way to being able to write basic R Markdown files. It's _that_ easy.

# Structure of an R Markdown file

An R Markdown file contains several parts. Most essential are the header, the body text, and code chunks.

## Header

Headers in R Markdown files contain some metadata about your document, which you can customize to your liking. Below is a simple example that purely states the title, author name(s), date, and output format. 

```yaml
---
title: "Untitled"
author: "NAME"
date: "July 28, 2017"
output: html_document
---
```

> ProTip: The header is written in "YAML", which means "yet another markup language." You don't need to know that, and don't worry about it. Just make sure you are careful with indenting, as YAML does care about that. 

For now, go ahead and make sure that `html_document` is set to `word_document`, except if you have strong preferences for `HTML` or `PDF`.^[Note: to create PDF documents you also need a TeX installation. Don't know what that is? You probably don't have it then. More info below.]

## Body text

The body of the document is where you actually write your reports. This is primarily written in the Markdown format, which is explained in the [Markdown syntax](#markdown-syntax) section.

The beauty of R Markdown is, however, that you can evaluate `R` code right in the text. To do this, you start inline code with \`r, type the code you want to run, and close it again with a \`. Usually, this key is below the escape (`ESC`) key  or next to the left SHIFT button.

For example, if you want to have the result of 48 minus 35 in your text, you type \` r 48-35\`, which returns `r 48 - 35`. Please note that if you return a value with many decimals, it will also print these depending on your settings (for example, `r pi`).

## Code chunks

In the section above we introduced you to running code inside text, but often you need to take several steps in order to get to the result you need. And you don't want to do data cleaning in the text! This is why there are code chunks. A simple example is a code chunk loading packages. 

First, insert a code chunk by going to `Code->Insert code chunk` or by pressing `CMD+OPTION+I` on a Mac or `CTRL+ALT+I` on a PC. Inside this code chunk you can then type for example, `library(ggplot2)` and create an object `x`. 

```{r}
library(ggplot2)

x <- 1 + 1
```

If you do not want to have the contents of the code chunk put into your document, you include `echo=FALSE` at the start of the code chunk. We can now use the contents from the above code chunk to print results (e.g., $x=`r x`$).

These code chunks can contain whatever you need, including tables, and figures (which we will go into more later). Note that all code chunks regard the location of the R Markdown as the working directory, so when you try to read in data use the relative path in.


# Markdown syntax

Markdown is one of the simplest document languages around, that is an open standard and can be converted into `.tex`, `.docx`, `.html`, `.pdf`, etc. This is the main workhorse of R Markdown and is very powerful. You can [learn Markdown in five (!) minutes](https://learnxinyminutes.com/docs/markdown/) Other resources include [http://rmarkdown.rstudio.com/authoring_basics.html](), and [this cheat sheet](https://www.rstudio.com/wp-content/uploads/2015/02/rmarkdown-cheatsheet.pdf). 

You can do some pretty cool tricks with Markdown, but these are the basics:

* It's easy to get `*italic*` or `**bold**`. 
* You can get headings using `# heading1` for first level, `## heading2` for second-level, and `### heading3` for third level. Make sure you leave a space after the `#`!
* Lists are delimited with `*` for each entry.
* You can write links by writing `[here's my link](http://foo.com)`.

If you want a more extensive description of all the potential of Markdown, [this introduction to Markdown](https://daringfireball.net/projects/markdown/) is highly detailed.

The great thing about Markdown is that it works almost everywhere! Github, OSF, slack, many wikis, and even in text documents it looks pretty good.  

## Exercises

1. Outlining using headings is a really great way to keep things organized! Try making a bunch of headings (i.e., *first*, *second*, and *third level* as described above) in your new markdown file, and then recompiling your document. 
2. Add a table of contents. This will involve going to the header of the document (the `YAML`), and adding some options to the `word document` bit. You want it to look like this (indentation must be correct):

```yaml
output: 
  word_document:
    toc: true
```

Now recompile. Looks nice, right?^[Pro-tip: you can specify how deep the TOC should go by adding `toc_depth: 2` to go two levels deep]

#  Graphs and Tables 

We're going to want more libraries loaded (for now we're loading them inline). If you've never used these packages before, you might need to install them!

```{r}
library(knitr)
library(ggplot2)
library(broom)
```
## Graphs

It's really easy to include graphs, like this one. (Using the `mtcars` dataset that comes with ggplot2).

```{r}
qplot(hp, mpg, col = factor(cyl), data = mtcars)
```

All you have to do is make the plot and it will render straight into the text. 

External graphics can also be included, as follows:

```{r eval = FALSE}
knitr::include_graphics("path/to/file")
```

## Tables

There are many ways to make good-looking tables using R Markdown, depending on your display purpose. 

- The `knitr` package (which powers R Markdown) comes with the `kable` function. It's versatile and makes perfectly reasonable tables. It also has a `digits` argument for controlling rounding. 

- For HTML tables, there is the `DT` package, which provides `datatable` -- these are pretty and interactive javascript-based tables that you can click on and search in. Not great for static documents though. 

- For APA manuscripts, it can also be helpful to use the `xtable` package, which creates very flexible LaTeX tables. These can be tricky to get right but they are completely customizable provided you want to google around and learn a bit about tex. 

We recommend starting with `kable`:

```{r}
kable(head(mtcars), digits = 1)
```

## Statistics

It's also really easy to include statistical tests of various types. 

For this, an option is the `broom` package, which formats the outputs of various tests really nicely. Paired with knitr's `kable` you can make very simple tables in just a few lines of code. 

```{r}
mod <- lm(mpg ~ hp + cyl, data = mtcars)
kable(tidy(mod), digits = 3)
```

Of course, cleaning these up can take some work. For example, we'd need to rename a bunch of fields to make this table have the labels we wanted (e.g., to turn `hp` into `Horsepower`). 

We often need APA-formatted statistics. We can compute them first, and then print them inline.

```{r}
ts <- t.test(mpg ~ am, data = mtcars)
```

> There's a statistically-significant difference in miles per gallon for cars with automatic vs. manual transmissions ($t(`r round(ts$parameter,2)`) = `r round(ts$statistic,2)`$, $p = `r round(ts$p.value,3)`$). 

To insert these stats inline I wrote e.g. `round(ts$parameter, 2)` inside an inline code block.^[APA would require omission of the leading zero. `papaja::printp()` will let you do that, see below.]

Note that rounding can occasionally get you in trouble here, because it's very easy to have an output of $p = 0$ when in fact $p$ can never be exactly equal to 0. Nonetheless, this can help you prevent rounding errors and the wrath of `statcheck`.

## Exercise

1. Using the `mtcars` dataset, insert a table and a graph of your choice into the document.^[If you're feeling uninspired, try `hist(mtcars$mpg)`.]
```{r}


```
[See the tutorial that Mike Frank and Chris Hartgerink taught together at SIPS 2017 for additional content!](https://github.com/mcfrank/rmarkdown-workshop)
