Zen and the Art of R Package Development

class: right middle hide-count
background-color: white
background-image: url(img/enso.jpg)
background-position: left

em {
  color: #D55E00FF;
  font-style: normal;
}

del {
  color: #E5E5E5;
  text-decoration: none;
  font-weight: normal;
}

.inverse del {
  color: #6C7B7F;
}

.bg-white-o90{
   background-color: rgba(255, 255, 255, 0.9);
}

.large { font-size: 175% }

.hide-count .remark-slide-number {
  display: none;
}

.text-poster {
	font-family: 'Cinzel', serif;
}

.inverse {
  color: #b9bfca;
  background-color: #282D35
}

.inverse.remark-slide-number {
  color: #b9bfca;
}

.remark-code-line-highlighted {
  color: #D55E00FF;
  background-color: transparent;
}

.remark-inline-code {
  color: #b9bfca;
}

.h2 {
  font-family: 'Karla'
}
</style>

Malcolm Barrett

Slides: [bit.ly/zenrpkgs](http://bit.ly/zenrpkgs)

---

# rstudio::conf(2020L)

---

# rstudio::conf(2020L)

## [My Organizaton's First R Package](https://my-org-first-pkg-2020.netlify.com/)

---

# rstudio::conf(2020L)

## ~~My Organizaton's First R Package~~
## [R Markdown Driven Development](https://resources.rstudio.com/rstudio-conf-2020/rmarkdown-driven-development-emily-riederer)

---

.footnote.pull-right[— Sandokai]

---

---

class: center, middle, hide-count
background-image: url(img/oxherding_1.jpg)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>structure your project</em>
</h1>
</div>

---

```
├── data/
├── reports/
├── scripts/
└── analysis.Rproj
```

---

```
├── data/
├── reports/
*├── R/
└── analysis.Rproj
```

---

```
*├── data/
├── reports/
├── R/
└── analysis.Rproj
```

---

```
├── data/ 
*├── vignettes/
├── R/
└── analysis.Rproj
```

---

```
├── data/ 
├── vignettes/ 
├── R/
*├── man/
*├── tests/
*├── DESCRIPTION
*├── NAMESPACE
└── analysis.Rproj
```

---

![](img/svg/create_package.svg)

---

```
├── data/ 
├── vignettes/ 
├── R/
├── man/ 
├── tests/ 
*├── DESCRIPTION
├── NAMESPACE
└── analysis.Rproj
```

---

```
Package: zenartofrpkgs
Title: What the Package Does (One Line, Title Case)
Version: 0.0.0.9000
Authors@R: 
    person(given = "Malcolm",
           family = "Barrett",
           role = c("aut", "cre"),
           email = "malcolmbarrett@gmail.com",
           comment = c(ORCID = "0000-0003-0299-5825"))
Description: What the package does (one paragraph).
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
```

---

![](img/svg/create_project.svg)

---

class: center, middle, hide-count
background-image: url(img/oxherding_2.jpg)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>write R code</em>
</h1>
</div>

---

![](img/svg/write_code.svg)

---

![](img/svg/use_r.svg)

---

![](img/svg/write_functions.svg)

---

![](img/svg/load_all.svg)

---

class: center, middle, hide-count
background-image: url(img/oxherding_3.jpg)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>declare your dependencies</em>
</h1>
</div>

---

![](img/svg/write_library.svg)

---

![](img/svg/use_package.svg)

---

![](img/svg/use_package_code.svg)

---

---

---

![](img/svg/use_package_install.svg)

---

class: center, middle, hide-count
background-image: url(img/oxherding_4.jpg)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>test your code</em>
</h1>
</div>

---

![](img/svg/fiddle.svg)

---

![](img/svg/use_test.svg)

---

# let's take a breath

---

# *Use a description file*

---

# ~~Use a description file~~
# *Write code as functions*
---

# ~~Use a description file~~
# ~~Write code as functions~~
# *Write down your tests; automate them*

---

.footnote.pull-right[— Shunryu Suzuki Roshi]

---

.footnote.pull-right[— Hadley Wickham]

---

class: center, middle, hide-count
background-image: url(img/oxherding_5.jpg)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>document your code</em>
</h1>
</div>

---

![](img/svg/comment.svg)

---

![](img/svg/use_roxygen_rmd.svg)

---

```
#' Plot mean sepal length by species
#'
#' @param size the size of the points
#'
#' @return a ggplot
#' @export
#'
#' @examples
#'
#' plot_iris()
#'
plot_iris <- function(size = 2) {
  iris %>%
    dplyr::group_by(Species) %>%
    dplyr::summarize(mean_sepal_length = mean(Sepal.Length)) %>%
    ggplot2::ggplot(ggplot2::aes(mean_sepal_length, Species)) +
    ggplot2::geom_point(size = 2)
}
```

---

![](img/svg/document.svg)

---

class: center, middle, hide-count
background-image: url(img/oxherding_6.jpg)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>clean your data</em>
</h1>
</div>

---

![](img/svg/use_data_raw.svg)

---

![](img/svg/use_data.svg)

---

class: center, middle, hide-count
background-image: url(img/oxherding_7.png)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>write reports</em>
</h1>
</div>
---

![](img/svg/use_vignette.svg)

---

![](img/svg/use_inst.svg)

---

![](img/svg/use_toplevel.svg)

---

class: center, middle, hide-count
background-image: url(img/oxherding_8.png)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>You already<br>share your code</em>
</h1>
</div>

---

![](img/svg/install.svg)

---

class: center, middle, hide-count
background-image: url(img/oxherding_9.jpg)
background-size: cover

<div class="f1 bg-white-o90 pa6 shadow-3 h-75">
<h1>
<em>Coming home<br>to R packages</em>
</h1>
</div>

---

# [R Markdown Driven Development](https://emilyriederer.netlify.com/post/rmarkdown-driven-development/)

---

# [rrtools](https://github.com/benmarwick/rrtools)

---

# [golem](https://thinkr-open.github.io/golem/)

---

# [drake](https://books.ropensci.org/drake/projects.html#workflows-as-r-packages)

---

# an invitation

## *create a package: a personal R package, something for your work, or turn a project into a package*

---

.footnote.pull-right[— Chögyam Trungpa Rinpoche]

---

class: center, middle, hide-count
background-image: url(img/oxherding_10.jpg)
background-size: cover

---

# [R Packages, 2nd Edition: Whole Game](https://r-pkgs.org/whole-game.html)

---

![](img/svg/goodbye.svg)