Package Development 101

class: center, middle, inverse, title-slide

.title[
# Package Development 101
]
.date[
### November 22, 2023
]

---

### Why create a package?

- Packages are a natural extension of functions

- When you have many interrelated functions it can be useful to combine them into one location (ie. a package)

- It's easier to share your code and collaborate with others

- They provide documentation, examples, and are tested to be robust

---

# Package Overview

.img-right[
<img src="data:image/png;base64,#../documents/r_pic.png" width="461" />
]

.unwrap[
<black>Libraries</black>
<gray>Creating a Package</gray>
 
 
<gray>Structure</gray>
 
 
<gray>Elements</gray> 
 
 
<gray>Development</gray> 
 
 
<gray>Final Checks</gray> 
 
 
<gray>Maintaining</gray> 
 
 
<gray>Resources</gray> 
]

---

### Package Overview: Libraries

**'RTools'**

- 'RTools' is required to develop packages in R

- Make sure you install the correct RTools for your R version (**[RTools versions](https://cran.r-project.org/bin/windows/Rtools/)**)

```r
install.packages('rtools')
library('rtools')
```

<div class="gray2">'devtools'</div>

---

### Package Overview: Libraries

<div class="gray2">'Rtools'</div>

**'devtools'**

- 'devtools' contains many useful and necessary functions to properly and easily setup the framework for a package

- 'devtools' includes other necessary packages such as: 'usethis', 'testthat', and 'roxygen2'

```r
install.packages('devtools')
library('devtools')
```

---

# Package Overview

.img-right[
<img src="data:image/png;base64,#../documents/r_pic.png" width="461" />
]

.unwrap[
<gray>Libraries</gray>
 
 
<black>Creating a Package</black>
 
 
<gray>Structure</gray>
 
 
<gray>Elements</gray> 
 
 
<gray>Development</gray> 
 
 
<gray>Final Checks</gray> 
 
 
<gray>Maintaining</gray> 
 
 
<gray>Resources</gray> 
]

---

### Package Overview: Creating a Package
1) Create a new project

<gray2>2) Start a new directory</gray2>
 
 
<gray2>3) Select 'R Package'</gray2>
 
 
<gray2>4) Name your package and setup a git repository to track changes</gray2>

---

### Package Overview: Creating a Package

<gray2>1) Create a new project</gray2>

2) Start a new directory

<gray2>3) Select 'R Package'</gray2>
 
 
<gray2>4) Name your package and setup a git repository to track changes</gray2>

---

### Package Overview: Creating a Package

<gray2>1) Create a new project</gray2>
 
 
<gray2>2) Start a new directory</gray2>

3) Select 'R Package'

<gray2>4) Name your package and setup a git repository to track changes</gray2>

---

### Package Overview: Creating a Package

<gray2>1) Create a new project</gray2>
 
 
<gray2>2) Start a new directory</gray2>
 
 
<gray2>3) Select 'R Package'</gray2>

4) Name your package and setup a git repository to track changes

---

# Package Overview

.img-right[
<img src="data:image/png;base64,#../documents/r_pic.png" width="461" />
]

.unwrap[
<gray>Libraries</gray>
 
 
<gray>Creating a Package</gray>
 
 
<black>Structure</black>
 
 
<gray>Elements</gray> 
 
 
<gray>Development</gray> 
 
 
<gray>Final Checks</gray> 
 
 
<gray>Maintaining</gray> 
 
 
<gray>Resources</gray> 
]

---

### Package Overview: Structure

.img-right[
<img src="data:image/png;base64,#../documents/folders.PNG" width="348" />
]

.unwrap[
- Key folders:
  - R
  - man
  - vignettes
  - tests
   
- Key files:
  - NAMESPACE
  - README
  - DESCRIPTION
  - LICENSE
]

---

# Package Overview

.img-right[
<img src="data:image/png;base64,#../documents/r_pic.png" width="461" />
]

.unwrap[
<gray>Libraries</gray>
 
 
<gray>Creating a Package</gray>
 
 
<gray>Structure</gray>
 
 
<black>Elements</black> 
 
 
<gray>Development</gray> 
 
 
<gray>Final Checks</gray> 
 
 
<gray>Maintaining</gray> 
 
 
<gray>Resources</gray> 
]

---