Templates

class: title-slide, center, middle

03

# Templates

## Young Statisticians Conference 2019

### Alison Hill &#183; RStudio

#### [https://ysc-rmarkdown.netlify.com/](https://ysc-rmarkdown.netlify.com/)

---
layout: true

<div class="my-footer">https://ysc-rmarkdown.netlify.com/</div>

---
class: middle, center, inverse

1

# Templates

---
class: live-code

# Demo using a template

+ The one that ships with `rmarkdown`
  + _File > New File > R Markdown_; select "Document"

+ One from my package
  + _File > New File > R Markdown_; select "From Template"

---
# What are we doing?

I built a package for us to use.

---

.left-column[

#

]

.right-column[

# Go here:

[https://github.com/ysc2019-workshop/03-templates](https://github.com/ysc2019-workshop/03-templates)

Click on "Use this template" (make sure you are logged in)

]

---

.left-column[

#

]

.right-column[

# In your repo

Click on green button, then the clipboard to copy HTTPS

<img src="images/cloud-from-https.png" width="3840" />
]

---

.left-column[

#

]

.right-column[

# Go to rstudio.cloud:

[http://bit.ly/ysc-rmarkdown](http://bit.ly/ysc-rmarkdown)

1. Join space > Click on "Projects" (nothing there)

1. New Project from GitHub Repo

1. Use **your** HTTPS link:

1. Name your project

]

---

.left-column[

#

]

.right-column[

# Last step!

I promise! Still in rstudio.cloud:

```r
library(usethis)
use_git_config(
  scope = "project",
  user.name = "Jane",
  user.email = "jane@example.org"
)
```

]

---
class: middle, center, inverse

2

# Packages

---
class: live-code

# Basic package anatomy

- NAMESPACE
- DESCRIPTION

```r
usethis::create_package(here::here())
```

---
class: live-code

# Basic template anatomy

+ `template.yaml`
+ `skeleton/skeleton.Rmd`

```r
usethis::use_rmarkdown_template("01-rmd")
```

---
class: middle, inverse, center

# DO NOT KNIT!

Do not try to knit the skeleton.Rmd

![](https://media.giphy.com/media/Vg6vGMxVs9Sve/giphy.gif)

---
class: your-turn

# Your turn

Open up my existing `basic-rmd` template &mdash; find in `inst/rmarkdown/templates/basic-rmd`.

1. Add your name and a title to this template.

1. Edit the YAML for the built-in `html_document` output format. Consider adding some of your favorite output options for the HTML format (theme? floating toc? parameters?)

1. Edit the content. Add a good `knitr` setup chunk at the top.

---
class: live-code

# Build package

We build the package using "Install and Restart" and confirm we see it locally.

---
class: live-code

# Use the template

We demo creating a new project in RStudio and using the template there so as not to pollute our package project.

---
class: middle, center, inverse

3

# Custom Styles

---
class: live-code

# Let's do a custom one

now we talk about adding supporting files like a logo and css. See my `custom-rmd` template.

---
class: your-turn

# Your turn

Figure out how the `custom-rmd` template works. Maybe talk with a partner/neighbor.

---
class: middle, center, inverse

4

# Extension Formats

---
class: live-code

# Let's look at my slide template

Check out `custom-xaringan` template together.

---
class: your-turn

# Your turn

Now try creating a fresh template on your own, and use an extension output format like:

+ `distill::distill_article`

+ `bookdown::html_document2`

+ `xaringan::moon_reader`

+ `flexdashboard::flexdashboard`

---
class: middle, center, inverse

5

# Custom Formats

---

# Possible!

https://bookdown.org/yihui/rmarkdown/new-formats.html

---
class: middle, center, inverse

# ⏱

# Time for a break!