Teach your package

background-image: url(https://i.imgur.com/CVIZGyY.jpg)
background-position: top
background-size: 100%
class: inverse, shadow

body {
  font-family: 'Fira Sans','Droid Serif', 'Palatino Linotype', 'Book Antiqua', Palatino, 'Microsoft YaHei', 'Songti SC', serif;
}

a, a > code {
  color: #EC99C6;
  text-decoration: none;
}

strong {
  color: #E69F00;
}

em {
  color: #56B4E9;
  font-style: normal;
  font-weight: bold;
}

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

.remark-code {
  font-family: 'IBM Plex Mono', 'Lucida Console', Monaco, monospace;
  font-size: 100%;
}

.remark-inline-code {
  font-family: 'Fira Sans', 'Lucida Console', Monaco, monospace;
  font-weight: 400;
  font-size: 100%;
}

.remark-code-line-highlighted {
  background-color: #CEE9FF;
  font-weight: 500;
}

.large { font-size: 130% }
.medium { font-size: 115% }
.small { font-size: 70% }

.remark-slide-content {
  color: #474747;
  font-weight: 300;
  font-weight: 300;
  padding: 1em 2em 1em 2em
}

h1 {
  color: #56B4E9;
  font-weight: 500;
}

h2 {
  font-weight: 500;
}

.remark-slide-number {
  font-size: 20px;
}

.title-slide .remark-slide-number {
  display: none;
}

.inverse.title-slide {
  background-size: cover;
  color: #EDEEEF;
}

.inverse.title-slide h1  {
  color: #E69F00;
  font-size: 72px;
  text-shadow: none;
  text-align: left;
  vertical-align: bottom;
}
.inverse.title-slide h2  {
  color: #56B4E9;
  text-shadow: none;
  font-size: 48px;
  text-align: left;
  font-weight: bold;
}
.inverse.title-slide h3  {
  color: #EDEEEF;
  text-shadow: none;
  font-size: 36px;
  text-align: left;
  margin-bottom: 10px;
}

.inverse.title-slide h4  {
  color: #EDEEEF;
  text-shadow: none;
  font-size: 24px;
  text-align: left;
  margin-bottom: 10px;
}

.inverse {
  background-size: cover;
  background-color: #23373B;
  color: #EDEEEF;
  font-weight: bold;
  text-shadow: none;
}

.inverse-ns {
  background-size: cover;
  background-color: #23373B;
  color: #EDEEEF;
  text-shadow: none;
  font-weight: bold;
}

.takeaways {
  padding-top: 80px;
}

.inverse h2, .inverse h3  {
  color: #EDEEEF;
  font-weight: 500;
}

.inverse del {
  color: #6C7B7F;
}

.shadow { text-shadow: 0 0 20px rgba(51,51,51,0.35) }

img {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

ul {
  font-size: 48px;
  list-style-type: none;
  text-align: left;
  font-weight: 500;
  padding-top: 40px;
}

ul li {
  padding-bottom: 40px;
}

ol {
  counter-reset: my-counter;
  list-style: none;
  padding-left: 40px;
  font-size: 45px;
  font-weight: bold;
  text-align: left;
}

ol li {
  counter-increment: my-counter;
  padding-left: 40px;
  position: relative;
  font-size: 45px;
  margin: 20px 0;
  display: block;
  margin-block-start: 0.83em;
  margin-block-end: 0.83em;
  margin-inline-start: 0;
  margin-inline-end: 0;
}

ol li::before {
  content: counter(my-counter);
  color: #fff;
  font-size: 40px;
  font-weight: bold;
  position: absolute;
  left: -25px;
  line-height: 50px;
  width: 50px;
  height: 50px;
  top: 0;
  background: #56B4E9;
  border-radius: 50%;
  text-align: center;
}</style>

# My Organization's First R package
## Teach your package
## `rstudio::conf(2020L)`

---

---

## Your Turn 1: Discussion

## What do you do when you want to learn a new package?

---

# Learning new packages

1. Examples
1. Vignettes/pkgdown
1. README
1. Blog posts
1. Books

---

# Learning new packages
 
1. **Examples**
1. Vignettes/pkgdown
1. README
1. Blog posts
1. Books

---

# Learning new packages

1. Examples
1. **Vignettes/pkgdown**
1. **README**
1. Blog posts
1. Books

---

# Guiding users

---

# Examples revisted

## If you don't want to run examples, wrap them in `dontrun{}` or `donttest{}`

```r
#' [other roxygen code]
#' @examples 
#'
*#' dontrun{
*#'   get_data("daily_active_users")
*#' }
get_data <- function(x) {
  # code to get data
}
```

---

# Examples revisted

## Don't mess around with the user's directory. Use `tempfile()` or fs if you need to.

```r
library(fs)
dir <- file_temp()
dir_create(dir)
```

---

```r
create_package(path(dir, "temp.package"))
```

```
## ✔ Creating '/var/folders/03/9x7925g54mncswxx06wpkxl00000gn/...
## ✔ Setting active project to '/private/var/folders/03/9x7925...
## ✔ Creating 'R/'
## ✔ Writing 'DESCRIPTION'```

```
## Package: temp.package
## Title: What the Package Does (One Line, Title Case)
## Version: 0.0.0.9000
## Authors@R (parsed):
##     * Malcolm Barrett <malcolmbarrett@gmail.com> [aut, cre] (<https://orcid.org/0000-0003-0299-5825>)
## Description: What the package does (one paragraph).
## License: MIT + file LICENSE
## Encoding: UTF-8
## LazyData: true
## Roxygen: list(markdown = TRUE)
```

```
## ✔ Writing 'NAMESPACE'
## ✔ Writing 'temp.package.Rproj'
## ✔ Adding '.Rproj.user' to '.gitignore'
## ✔ Adding '^temp\\.package\\.Rproj$', '^\\.Rproj\\.user$' to...
## ✔ Opening '/var/folders/ 03/9x7925g54mncswxx06wpkxl00000gn/...
## ✔ Setting active project to '<no active project>'```

---

# Vignettes

## Long-form documentation, written in [R Markdown](https://rmarkdown.rstudio.com/)

---

# Vignettes

## ~~Long-form documentation, written in R Markdown~~
## Great for general introductions and complex topics you don't want buried in the documentation

---

# Vignettes

## ~~Long-form documentation, written in R Markdown~~
## ~~Great for general introductions and complex topics you don't want buried in the documentation~~
## Get rendered on pkgdown sites. See also `use_article()`

---

# Vignettes

## ~~Long-form documentation, written in R Markdown~~
## ~~Great for general introductions and complex topics you don't want buried in the documentation~~
## ~~Get rendered on pkgdown sites. See also `use_article()`~~
## `use_vignette()`

---

---

---

---

---

# Need a Markdown refresher?

## Interactive, 10-20 min tutorial: https://commonmark.org/help/tutorial/

## The R Markdown [website](https://rmarkdown.rstudio.com/) or [book](https://bookdown.org/yihui/rmarkdown/)

---

## Your Turn 2

#### Open `vignettes/intro-to-avalanchr.Rmd`.
#### Let's add some more content before we knit this vignette. Lines 27-29 have an R Markdown code chunk. On line 28, fill in the blank with this code: `db_con("residents_per_sector")`
#### Let's also add some examples of the summarizing and plotting functions. On line 57, fill in the blank with `count_donations()`. On line 62, use `plot_donations()`
#### Knit the vignette. If you're having trouble finding some of your functions, try re-loading or documenting and re-building.

---

# README

## **A quick overview of your package**

---

# README

## ~~A quick overview of your package~~
## **A good place for installation instructions**

---

# README

## ~~A quick overview of your package~~
## ~~A good place for installation instructions~~
## **Becomes the homepage for a pkgdown site**

---

# README

## ~~A quick overview of your package~~
## ~~A good place for installation instructions~~
## ~~Becomes the homepage for a pkgdown site~~
## *`use_readme_md()`* or *`use_readme_rmd()`*

---

# What should I put in the README?

1. Badges (`?use_badge()`), where applicable.
2. Installation instructions
3. A few examples
4. Maybe: how to contribute (`use_tidy_contributing()`)

---
.pull-left[
## R Packages: [ggplot2's README](https://github.com/tidyverse/ggplot2)
]

.pull-right[
<img src="img/readme_ggplot2.png" width="100%" height="100%" style="display: block; margin: auto;" />
]

---

.pull-left[
## Other READMEs: [Zhi Yang's TidyTuesday repo](https://github.com/zhiiiyang/tidytuesday)
]

.pull-right[
<img src="img/readme_zhi.png" width="100%" height="100%" style="display: block; margin: auto;" />
]

---

.pull-left[
## Other READMEs: [Zhi Yang's TidyTuesday repo](https://github.com/zhiiiyang/tidytuesday)
## Check out ["Building a Better README"](https://blog.sourcerer.io/building-a-better-readme-d5053a7bc341)
]

.pull-right[
<img src="img/readme_zhi.png" width="100%" height="100%" style="display: block; margin: auto;" />
]

---

## Your Turn 3

## Run `use_readme_rmd()` to setup a README. Knit the file and take a look.
## Let's add some badges. Run `use_lifecycle_badge("experimental")` and `use_cran_badge()`. Then, re-knit.

---

# Spell check with the [spelling](https://docs.ropensci.org/spelling/) package

## `use_spell_check()`