Chapter 1 Introduction
In R, the fundamental unit of shareable code is the package. A package bundles together code, data, documentation, and tests, and is easy to share with others. As of June 2019, there were over 14,000 packages available on the Comprehensive R Archive Network, or CRAN, the public clearing house for R packages. This huge variety of packages is one of the reasons that R is so successful: the chances are that someone has already solved a problem that you’re working on, and you can benefit from their work by downloading their package.
If you’re reading this book, you already know how to use packages:
- You install them from CRAN with
- You use them in R with
- You get help on them with
help(package = "x").
The goal of this book is to teach you how to develop packages so that you can write your own, not just use other people’s. Why write a package? One compelling reason is that you have code that you want to share with others. Bundling your code into a package makes it easy for other people to use it, because like you, they already know how to use packages. If your code is in a package, any R user can easily download it, install it and learn how to use it.
But packages are useful even if you never share your code. As Hilary Parker says in her introduction to packages: “Seriously, it doesn’t have to be about sharing your code (although that is an added benefit!). It is about saving yourself time.” Organising code in a package makes your life easier because packages come with conventions. For example, you put R code in
R/, you put tests in
tests/ and you put data in
data/. These conventions are helpful because:
They save you time — you don’t need to think about the best way to organise a project, you can just follow a template.
Standardised conventions lead to standardised tools — if you buy into R’s package conventions, you get many tools for free.
This book espouses our philosophy of package development: anything that can be automated, should be automated. Do as little as possible by hand. Do as much as possible with functions. The goal is to spend your time thinking about what you want your package to do rather than thinking about the minutiae of package structure.
This philosophy is realised primarily through the devtools package, which is the public face for a suite of R functions that automate common development tasks. The release of version 2.0.0 in October 2018 marked its internal restructuring into a set of more focused packages, with devtools becoming more of a meta-package. The usethis package is the sub-package you are most likely to interact with directly; we explain the devtools-usethis relationship in section 3.2.
As always, the goal of devtools is to make package development as painless as possible. It encapsulates the best practices developed by first author Hadley Wickham, initially from years as a prolific solo developer. More recently, he has assembled a team of ~10 developers at RStudio, who collectively look after ~150 open source R packages, including those known as the tidyverse. The reach of this team allows us to explore the space of all possible mistakes at an extraordinary scale. Fortunately, it also affords us the opportunity to reflect on both the successes and failures, in the company of expert and sympathetic colleagues. We try to develop practices that make life more enjoyable for both the maintainer and users of a package. The devtools meta-package is where these lessons are made concrete.
Through the book, we highlight specific ways that RStudio can expedite your package development workflow, in specially formatted sections like this.
devtools works hand-in-hand with RStudio, which we believe is the best development environment for most R users. The main alternative is Emacs Speaks Statistics (ESS), which is a rewarding environment if you’re willing to put in the time to learn Emacs and customise it to your needs. The history of ESS stretches back over 20 years (predating R!), but it’s still actively developed and many of the workflows described in this book are also available there. For those loyal to vim, we recommend the Nvim-R plugin.
Together, devtools and RStudio insulate you from the low-level details of how packages are built. As you start to develop more packages, we highly recommend that you learn more about those details. The best resource for the official details of package development is always the official writing R extensions manual. However, this manual can be hard to understand if you’re not already familiar with the basics of packages. It’s also exhaustive, covering every possible package component, rather than focussing on the most common and useful components, as this book does. Writing R extensions is a useful resource once you’ve mastered the basics and want to learn what’s going on under the hood.
1.2 In this book
Chapter 2 runs through the development of a small toy package. It’s meant to paint the Big Picture and suggest a workflow, before we descend into the detailed treatment of the key components of an R package.
Chapter 3 describes how to prepare your system for package development, which has more requirements than simply running R scripts. This includes recommendations on some optional setup that can make your workflow more pleasant, which tends to lead to a higher-quality product.
The basic structure of a package and how that varies across different states is explained in chapter 17.2.2.
Chapter 5 goes over core workflows that come up repeatedly for package developers. This chapter also covers connections between our favored tools, such as devtools/usethis and RStudio, and the philosophies that drive the design of these tools.
Subsequent chapters of the book go into more details about each package component. They’re roughly organised in order of importance:
R code, chapter 6: the most important directory is
R/, where your R code lives. A package with just this directory is still a useful package. (And indeed, if you stop reading the book after this chapter, you’ll have still learned some useful new skills.)
Package metadata, chapter 7: the
DESCRIPTIONlets you describe what your package needs to work. If you’re sharing your package, you’ll also use the
DESCRIPTIONto describe what it does, who can use it (the license), and who to contact if things go wrong.
Documentation, chapter 8: if you want other people (including future-you!) to understand how to use the functions in your package, you’ll need to document them. We’ll show you how to use roxygen2 to document your functions. We recommend roxygen2 because it lets you write code and documentation together while continuing to produce R’s standard documentation format.
Vignettes, chapter 9: function documentation describes the nit-picky details of every function in your package. Vignettes give the big picture. They’re long-form documents that show how to combine multiple parts of your package to solve real problems. We’ll show you how to use Rmarkdown and knitr to create vignettes with a minimum of fuss.
Tests, chapter 10: to ensure your package works as designed (and continues to work as you make changes), it’s essential to write unit tests which define correct behaviour, and alert you when functions break. In this chapter, we’ll teach you how to use the testthat package to convert the informal interactive tests that you’re already doing to formal, automated tests.
Namespace, chapter 11: to play nicely with others, your package needs to define what functions it makes available to other packages and what functions it requires from other packages. This is the job of the
NAMESPACEfile and we’ll show you how to use roxygen2 to generate it for you. The
NAMESPACEis one of the more challenging parts of developing an R package but it’s critical to master if you want your package to work reliably.
External data, chapter 12: the
data/directory allows you to include data with your package. You might do this to bundle data in a way that’s easy for R users to access, or just to provide compelling examples in your documentation.
Compiled code, chapter 13: R code is designed for human efficiency, not computer efficiency, so it’s useful to have a tool in your back pocket that allows you to write fast code. The
src/directory allows you to include speedy compiled C and C++ code to solve performance bottlenecks in your package.
Other components, chapter 15: this chapter documents the handful of other components that are rarely needed:
The final chapters describe general best practices not specifically tied to one directory:
Git and GitHub, chapter 16: mastering a version control system is vital to easily collaborate with others, and is useful even for solo work because it allows you to easily undo mistakes. In this chapter, you’ll learn how to use the popular Git and GitHub combo with RStudio.
Automated checking, chapter 17: R provides very useful automated quality checks in the form of
R CMD check. Running them regularly is a great way to avoid many common mistakes. The results can sometimes be a bit cryptic, so we provide a comprehensive cheatsheet to help you convert warnings to actionable insight.
Release, chapter 18: the life-cycle of a package culminates with release to the public. This chapter compares the two main options (CRAN and GitHub) and offers general advice on managing the process.
This is a lot to learn, but don’t feel overwhelmed. Start with a minimal subset of useful features (e.g. just an
R/ directory!) and build up over time. To paraphrase the Zen monk Shunryu Suzuki: “Each package is perfect the way it is — and it can use a little improvement”.
Since the first edition of R Packages was published, the packages supporting the workflows described here have undergone extensive development. The original trio of devtools, roxygen2, and testthat has expanded to include the packages created by the “conscious uncoupling” of devtools. Most of these packages originate with Hadley Wickham (HW), because of their devtools roots. There are many other significant contributors, many of whom now serve as maintainers:
- devtools: HW, Winston Chang, Jim Hester (maintainer, >= v1.13.5)
- usethis: HW, Jennifer Bryan (maintainer >= v1.5.0)
- roxygen2: HW (maintainer), Peter Danenburg, Manuel Eugster
- testthat: HW (maintainer)
- desc: Gábor Csárdi (maintainer), Kirill Müller, Jim Hester
- pkgbuild: HW, Jim Hester (maintainer)
- pkgload: HW, Jim Hester (maintainer), Winston Chang
- rcmdcheck: Gábor Csárdi (maintainer)
- remotes: HW, Jim Hester (maintainer), Gábor Csárdi, Winston Chang, Martin Morgan, Dan Tenenbaum
- revdepcheck: HW, Gábor Csárdi (maintainer)
- sessioninfo: HW, Gábor Csárdi (maintainer), Winston Chang, Robert Flight, Kirill Müller, Jim Hester
This book and the R package development community benefit tremendously from experts who smooth over specific pain points:
- Kevin Ushey, JJ Allaire, and Dirk Eddelbuettel tirelessly answered all sorts of C, C++, and Rcpp questions.
- Craig Citro wrote much of the initial code to facilitate using Travis-CI with R packages.
- Jeroen Ooms also helps to maintain R community infrastructure, such as the current R support for Travis-CI (along with Jim Hester), and the Windows toolchain.
TODO: revisit rest of this section when 2nd edition nears completion. Currently applies to and worded for 1st edition.
Often the only way I learn how to do it the right way is by doing it the wrong way first. For suffering through many package development errors, I’d like to thank all the CRAN maintainers, especially Brian Ripley, Uwe Ligges and Kurt Hornik.
This book was written and revised in the open and it is truly a community effort: many people read drafts, fix typos, suggest improvements, and contribute content. Without those contributors, the book wouldn’t be nearly as good as it is, and we are deeply grateful for their help.
A special thanks goes to Peter Li, who read the book from cover-to-cover and provided many fixes. I also deeply appreciate the time the reviewers (Duncan Murdoch, Karthik Ram, Vitalie Spinu and Ramnath Vaidyanathan) spent reading the book and giving me thorough feedback.
Thanks go to all contributors who submitted improvements via github (in alphabetical order):
@adessy, Adrien Todeschini, Andrea Cantieni, Andy Visser,
@apomatix, Ben Bond-Lamberty, Ben Marwick, Brett K, Brett Klamer,
@contravariant, Craig Citro, David Robinson, David Smith,
@davidkane9, Dean Attali, Eduardo Ariño de la Rubia, Federico Marini, Gerhard Nachtmann, Gerrit-Jan Schutten, Hadley Wickham, Henrik Bengtsson,
@heogden, Ian Gow,
@jacobbien, Jennifer (Jenny) Bryan, Jim Hester,
@jmarshallnz, Jo-Anne Tan, Joanna Zhao, Joe Cainey, John Blischak,
@jowalski, Justin Alford, Karl Broman, Karthik Ram, Kevin Ushey, Kun Ren,
@lancelote, Lech Madeyski,
@maiermarco, Manuel Reif, Michael Buckley,
@MikeLeonard, Nick Carchedi, Oliver Keyes, Patrick Kimes, Paul Blischak, Peter Meissner,
@PeterDee, Po Su, R. Mark Sharp, Richard M. Smith,
@rmsharp, Robert Krzyzanowski,
@ryanatanner, Sascha Holzhauer,
@scharne, Sean Wilkinson,
@SimonPBiggs, Stefan Widgren, Stephen Frank, Stephen Rushe, Tony Breyal, Tony Fischetti,
@urmils, Vlad Petyuk, Winston Chang,
The light bulb image used for workflow tips comes from www.vecteezy.com.
Throughout this book, we write
foo() to refer to functions,
bar to refer to variables and function parameters, and
baz/ for paths.
Larger code blocks intermingle input and output. Output is commented so that if you have an electronic version of the book, e.g., https://r-pkgs.org, you can easily copy and paste examples into R. Output comments look like
#> to distinguish them from regular comments.
This book was authored using R Markdown, using bookdown, inside RStudio. The website is hosted with Netlify, and automatically updated after every commit by Travis-CI. The complete source is available from GitHub.
This version of the book was built with:
library(devtools) #> Loading required package: usethis library(roxygen2) library(testthat) #> #> Attaching package: 'testthat' #> The following object is masked from 'package:devtools': #> #> test_file ::session_info() devtools#> ─ Session info ─────────────────────────────────────────────────────────────── #> setting value #> version R version 4.0.2 (2020-06-22) #> os Ubuntu 20.04.1 LTS #> system x86_64, linux-gnu #> ui X11 #> language en_US:en #> collate en_US.UTF-8 #> ctype en_US.UTF-8 #> tz Etc/UTC #> date 2020-08-12 #> #> ─ Packages ─────────────────────────────────────────────────────────────────── #> package * version date lib #> assertthat 0.2.1 2019-03-21  #> backports 1.1.8 2020-06-17  #> bookdown 0.20 2020-06-23  #> callr 3.4.3 2020-03-28  #> cli 2.0.2 2020-02-28  #> crayon 1.3.4 2017-09-16  #> desc 1.2.0 2018-05-01  #> devtools * 22.214.171.12400 2020-07-31  #> digest 0.6.25 2020-02-23  #> ellipsis 0.3.1 2020-05-15  #> evaluate 0.14 2019-05-28  #> fansi 0.4.1 2020-01-08  #> fs 1.5.0 2020-07-31  #> glue 1.4.1 2020-05-13  #> htmltools 0.5.0 2020-06-16  #> knitr 1.29 2020-06-23  #> magrittr 1.5 2014-11-22  #> memoise 1.1.0 2017-04-21  #> pkgbuild 1.1.0 2020-07-13  #> pkgload 1.1.0 2020-05-29  #> prettyunits 1.1.1 2020-01-24  #> processx 3.4.3 2020-07-05  #> ps 1.3.4 2020-08-11  #> purrr 0.3.4 2020-04-17  #> R6 2.4.1 2019-11-12  #> Rcpp 1.0.5 2020-07-06  #> remotes 2.2.0 2020-07-21  #> rlang 0.4.7 2020-07-09  #> rmarkdown 2.3 2020-06-18  #> roxygen2 * 7.1.1 2020-06-27  #> rprojroot 1.3-2 2018-01-03  #> sessioninfo 1.1.1 2018-11-05  #> stringi 1.4.6 2020-02-17  #> stringr 1.4.0 2019-02-10  #> testthat * 126.96.36.19900 2020-07-31  #> usethis * 1.6.1 2020-04-29  #> withr 2.2.0 2020-04-20  #> xfun 0.16 2020-07-24  #> xml2 1.3.2 2020-04-23  #> zhuoerdown 0.2.0 2020-08-12  #> source #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> Github (r-lib/devtools@df619ce) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> Github (r-lib/testthat@0af11cd) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> CRAN (R 4.0.2) #> Github (dongzhuoer/zhuoerdown@8b80bd9) #> #>  /usr/local/lib/R/site-library #>  /usr/lib/R/site-library #>  /usr/lib/R/library
Marwick, Ben, Carl Boettiger, and Lincoln Mullen. 2018a. “Packaging Data Analytical Work Reproducibly Using R (and Friends).” The American Statistician 72 (1): 80–88. https://doi.org/10.1080/00031305.2017.1375986.
Marwick, Ben, Carl Boettiger, and Lincoln Mullen. 2018b. “Packaging Data Analytical Work Reproducibly Using R (and Friends).” PeerJ Preprints 6 (March): e3192v2. https://doi.org/10.7287/peerj.preprints.3192v2.