Advanced RMarkdown

# Advanced RMarkdown
## Going Deeper with R

---

layout: true
  
<div class="dk-footer">
<span>
<a href="https://rfortherestofus.com/" target="_blank">R for the Rest of Us
</a>
</span>
</div>

---

background-image:url("images/text.jpg")

# Advanced Markdown Text Formatting

---

## Links

This is a [link to the Rest for the Rest of Us website](http://rfortherestofus.com/)

![](images/markdown-text-link.png)

---

## Images

![](images/kid-screaming.gif)

<br>

![](images/markdown-text-image.png)

---

## Block quotes

> Four score and seven years ago our fathers brought forth on this continent, a new nation, conceived in Liberty, and dedicated to the proposition that all men are created equal.

<br>

![](images/markdown-text-blockquote.png)

---

## Footnotes

^[This is a footnote]

---
class: center, middle

## `remedy`

---

## My Turn

Working in my RMarkdown report created in the data visualization section, I'll do the following:

1. Add a link

1. Add an image

1. Add a block quote

1. Add a footnote

---

## Your Turn

- Add the Oregon Department of Education logo to the top of your report. You can find it at https://github.com/rfortherestofus/going-deeper/raw/master/slides/images/ode-logo.jpg

- Add the following text (make sure you include the link, which points to https://www.oregon.gov/ode/pages/default.aspx):

This is a report for the [Oregon Department of Education](https://www.oregon.gov/ode/pages/default.aspx) on diversity in Oregon school districts. 
  
---

## Your Turn (continued)

- Add the following text as a block quote:

> The Oregon Department of Education fosters equity and excellence for every learner through collaboration with educators, partners, and communities.

- Add a link to the source for mission statement above (https://www.oregon.gov/ode/about-us/Pages/default.aspx) as a footnote.

---

background-image:url("images/table.jpg")

# Tables

---

## Don't Use the Default

---

## Data Frame Printing

```r
---
title: "Snazzy Report"
output:
  html_document:
*   df_print: tibble
---
```

![](images/tibble.png)

---

## Data Frame Printing

```r
---
title: "Snazzy Report"
output:
  html_document:
*   df_print: kable
---
```

![](images/kable.png)

---

## Data Frame Printing

```r
---
title: "Snazzy Report"
output:
  html_document:
*   df_print: paged
---
```

![](images/paged-table.png)

---

background-image:url("images/packages.jpg")

## Table Packages

---

### gt

---

### kable + kableExtra

.center[
![](images/kableExtra-example.png)
.small[
Source: [Sharla Gelfand](https://twitter.com/sharlagelfand/status/1192674485792641024)
]
.button[
[Learn more about kableExtra](https://cran.r-project.org/web/packages/kableExtra/vignettes/awesome_table_in_html.html)
]
]

---

### formattable

![](images/formattable.png)

---

### DT

![](images/DT-example.gif)

---

### reactable

![](images/reactable-example.png)

---

### flextable

---

## My Turn

I'll demonstrate making an effective table using `gt`

???

- Title
- Set Names (cols_label)
- Align
- Width
- Formatting numbers
- Color shading
- Source

---

## Your Turn

Do the following:

1. Change the default data frame printing method to use kable

1. Choose one of the table packages and make an attractive table that shows the top 10 districts with the highest percentage of Hispanic/Latino students (hint: use the `slice_max()` function to get the top 10 and the `fmt_percent()` function if you're using `gt` or the `percent()` function otherwise to display the percentage of Hispanic/Latino students in each)

---

background-image:url("images/book.jpg")

# Advanced YAML

---

## Table of Contents

```r
---
title: "Snazzy Report"
output:
  html_document:
*   toc: TRUE
    toc_depth: 2 
    toc_float: TRUE
---
```

---

## Table of Contents

```r
---
title: "Snazzy Report"
output:
  html_document:
    toc: TRUE 
*   toc_depth: 2
    toc_float: TRUE
---
```

---

## Table of Contents

```r
---
title: "Snazzy Report"
output:
  html_document:
    toc: TRUE
    toc_depth: 2 
*   toc_float: TRUE
---
```

![](images/floating-toc.gif)

---

## Figure Options

```r
---
title: "Snazzy Report"
output:
  html_document:
*   fig_width: 7
    fig_height: 6
    fig_caption: TRUE
---
```

---

## Figure Options

```r
---
title: "Snazzy Report"
output:
  html_document:
    fig_width: 7 
*   fig_height: 6
    fig_caption: TRUE
---
```

---

## Figure Options

```r
---
title: "Snazzy Report"
output: 
  html_document:
    fig_width: 7 
    fig_height: 6 
*   fig_caption: TRUE
---
```

???

You can also do this in the setup chunk and/or in individual code chunks

https://twitter.com/xieyihui/status/1232762844980137984

---

## Parameters

```r
---
title: "Snazzy Report"
output: html_document
  params:
*   state: "California"
---
```

---

## Parameters

![](images/knit-with-parameters.png)

???

Learn More

https://medium.com/@urban_institute/iterated-fact-sheets-with-r-markdown-d685eb4eafce

---

## Additional Options

.pull-left[
[![](images/rmarkdown-definitive-guide-cover.png)](https://bookdown.org/yihui/rmarkdown/html-document.html)
]

???

TK: Here is where to talk about how you can do this as code chunk options as well I think

---

## My Turn

I'll do the following:

1. Add a table of contents

1. Adjust default figure height, width, and captions

1. Add a parameter to the YAML and use it in the body of my report

1. Knit to make sure everything works

---

## Your Turn

1. Add a table of contents and make it floating

1. Adjust default figure height, width, and captions

1. Add a parameter to the YAML and use it in the body of your report to dynamically create a table of the top 10 districts by various race/ethnicity categories.

---

background-image:url("images/inline-skating.jpg")

# Inline R Code

---

## Inline R code

These two bits of text look identical, right?

In 2019, there were 854 German speakers in California.

---

## Inline R code

They're not identical!

In 2019, there were 854 German speakers in California.

![](images/inline-r-code-no-shading.png)

---

## Inline R code

![](images/inline-r-code.png)

---

## My Turn

I'll add a line to my report that uses inline R code

---

## Your Turn

Add a line to your report that uses inline R code

---

background-image:url("images/microsoft-word.jpg")

# Making Your Reports Shine: Word Edition

---

## Making Your Reports Shine: Word Edition

```r
---
title: "Snazzy Report"
output:
    word_document:
      reference_docx: my-word-template.docx
---
```

???

https://templates.office.com/en-us/team-report-tm00002118

---

## My Turn

I'll do the following:

1. Use a reference document to change the look and feel of my reports that are knitted to Word

---

## Your Turn

Use a reference document to change the look and feel of your report when knitted to Word

---

## Making Your Reports Shine: HTML Edition

![](images/rmarkdown-html-themes.png)

???

- https://rstudio.github.io/distill/
- https://github.com/hrbrmstr/markdowntemplates
- https://prettydoc.statr.me/themes.html
- https://github.com/juba/rmdformats
- https://www.datadreaming.org/post/r-markdown-theme-gallery/
- https://pagedown.rbind.io/

If you want to really customize, you need to learn CSS

- https://www.freecodecamp.org/learn/responsive-web-design/basic-css/

---

## My Turn

I'll convert my report to distill format

---

## Your Turn

Change the theme of your report by adding a theme option to your YAML. Use any of the following options: “cerulean”, “cosmo”, “flatly”, “journal”, “lumen”, “paper”, “readable”, “sandstone”, “simplex”, “spacelab”, “united”, and “yeti”

---