dlab-berkeley / R-package-development

R package development workshop

R Package Development Workshop

by Jae Yeon Kim

File an issue if you have problems, questions or suggestions.

Overview

Developing your own R package is a great way to reuse and distribute your R code. The workshop aims to demonstrate that developing and distributing an R package is easy to do, if you know how to write functions and use Git and GitHub.

Learning objectives

• Developing your first and minimally viable R package

Prerequisites

I assume students have familiarity R and Git and GitHub.

If you haven't done, please install Git and sign up a new GitHub account.

• Install Git.

• Sign up a GitHub account. Also, don't forget to set up your user name and email.

Setup

Please install required packages manually before attending the workshop:

# package manager
install.packages("pacman")
library(pacman)

# install pkgs
pacman::p_load(
    devtools, # key package 
    usethis, # workflow management 
    testthat, # for testing 
    roxygen2, # for documentation 
    pkgdown # to build a package website
)

References

• R Packages by Hadley Wickam (O'Reily 2015)
  • The second edition is now under development written by Hadley Wickam and Jerry Bryan.
• Writing an R package from scratch by Hilary Parker
• R package primer by Karl Broman
• usethis workflow for package development by Emil Hvitfeldt

This work is licensed under a Creative Commons Attribution 4.0 International License.