Tools to Make Developing R Packages Easier
Collection of package development tools.
The aim of devtools is to make package development easier by providing R functions that simplify and expedite common tasks. R Packages is a book based around this workflow.
# Install devtools from CRAN install.packages("devtools") # Or the development version from GitHub: # install.packages("devtools") devtools::install_github("r-lib/devtools")
All devtools functions accept a path as an argument, e.g.
load_all("path/to/mypkg"). If you don't specify a path, devtools will
look in the current working directory - this is recommended practice.
Frequent development tasks:
load_all()simulates installing and reloading your package, loading R code in
R/, compiled shared objects in
src/and data files in
data/. During development you usually want to access all functions (even un-exported internal ones) so
load_all()works as if all functions were exported in the package
document()updates generated documentation in
man/, file collation and
test()reloads your code with
load_all(), then runs all
test_coverage()runs test coverage on your package with covr. This makes it easy to see what parts of your package could use more tests!
Building and installing:
install()reinstalls the package, detaches the currently loaded version then reloads the new version with
library(). Reloading a package is not guaranteed to work: see the documentation for
build()builds a package file from package sources. You can use it to build a binary version of your package.
install_*functions install an R package:
install_url()from an arbitrary url
install_svn()from an arbitrary git or SVN repository
install_local()from a local file on disk
install_version()from a specific version on CRAN
update_packages()updates a package to the latest version. This works both on packages installed from CRAN as well as those installed from any of the
Check and release:
check()updates the documentation, then builds and checks the package locally.
check_win()checks a package using win-builder, and
check_rhub()checks a package using r-hub. This allows you to easily check your package on all systems CRAN uses before submission.
release()makes sure everything is ok with your package (including asking you a number of questions), then builds and uploads to CRAN.
R package development can be intimidating, however there are now a number of valuable resources to help!
R Packages is a book that gives a comprehensive treatment of all common parts of package development and uses devtools throughout.
- The first edition is available at http://r-pkgs.had.co.nz, but note that it has grown somewhat out of sync with the current version of devtools.
- A second edition is under development and is evolving to reflect the current state of devtools. It is available at http://r-pkgs.org.
- The Whole Game and Package structure chapters make great places to start.
RStudio community - package development is a great place to ask specific questions related to package development.
rOpenSci packages has extensive documentation on best practices for R packages looking to be contributed to rOpenSci, but also very useful general recommendations for package authors.
There are a number of fantastic blog posts on writing your first package, including
Writing R Extensions is the exhaustive, canonical reference for writing R packages, maintained by the R core developers.
devtools started off as a lean-and-mean package to facilitate local package development, but over the years it accumulated more and more functionality. devtools has undergone a conscious uncoupling to split out functionality into smaller, more tightly focussed packages. This includes:
testthat: Writing and running tests (i.e.
roxygen2: Function and package documentation (i.e.
remotes: Installing packages (i.e.
pkgbuild: Building binary packages (including checking if build tools are available) (i.e.
pkgload: Simulating package loading (i.e.
rcmdcheck: Running R CMD check and reporting the results (i.e.
revdepcheck: Running R CMD check on all reverse dependencies, and figuring out what's changed since the last CRAN release (i.e.
sessioninfo: R session info (i.e.
usethis: Automating package setup (i.e.
Generally, you should not need to worry about these different packages, because devtools installs them all automatically. You will need to care, however, if you're filing a bug because reporting it at the correct place will lead to a speedier resolution.
You also may need to care if you are trying to use some devtools functionality
in your own package or deployed application. Generally in these cases it
is better to depend on the particular package directly rather than depend on devtools,
sessioninfo::session_info() rather than
However for day to day development we recommend you continue to use
library(devtools) to quickly load all needed development tools, just like
library(tidyverse) quickly loads all the tools necessary for data exploration
Code of conduct
Please note that the devtools project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Functions in devtools
|clean_vignettes||Clean built vignettes.|
|dev_sitrep||Report package development situation|
|lint||Lint all source files in a package.|
|devtools||Package development tools for R.|
|wd||Set working directory.|
|r_env_vars||Environment variables to set when calling R|
|reexports||Objects exported from other packages|
|create||Create a package|
|is.package||Is the object a package?|
|load_all||Load complete package.|
|check_rhub||Run CRAN checks for package on R-hub|
|loaded_packages||Return a vector of names of attached packages|
|devtest||Return the path to one of the packages in the devtools test dir|
|remote-reexports||Functions re-exported from the remotes package|
|reload||Unload and reload package.|
|source_gist||Run a script on gist|
|bash||Open bash shell in package directory.|
|document||Use roxygen to document a package.|
|missing_s3||Find missing s3 exports.|
|check_win||Build windows binary package.|
|package_file||Find file in a package.|
|dev_mode||Activate and deactivate development mode.|
|save_all||Save all documents in an active IDE session.|
|dev_packages||Return a vector of names of packages loaded by devtools|
|github_pat||Retrieve GitHub personal access token.|
|has_tests||Was devtools installed with tests?|
|show_news||Show package news|
|install_deps||Install package dependencies if needed.|
|release_checks||Custom devtools release checks.|
|install||Install a local development package.|
|source_url||Run a script through some protocols such as http, https, ftp, etc.|
|release||Release package to CRAN.|
|revdep||Reverse dependency tools.|
|submit_cran||Submit a package to CRAN.|
|uninstall||Uninstall a local development package.|
|test||Execute test_that tests in a package.|
|run_examples||Run all examples in a package.|
|check_man||Check documentation, as R CMD check does.|
|check_failures||Parses R CMD check log file for ERRORs, WARNINGs and NOTEs|
|as.package||Coerce input to a package.|
|build_vignettes||Build package vignettes.|
|check||Build and check a package, cleaning up automatically on success.|
|build_manual||Create package pdf manual|
|build_readme||Build a Rmarkdown README for a package|
|build_site||Execute pkgdown build_site in a package|
Vignettes of devtools
Last month downloads
|License||GPL (>= 2)|
|Packaged||2019-09-24 13:01:37 UTC; jhester|
|Date/Publication||2019-09-24 15:00:02 UTC|
|suggests||BiocManager , bitops , curl (>= 0.9) , evaluate , foghorn (>= 1.1.0) , gmailr (> 0.7.0) , knitr , lintr (>= 0.2.1) , MASS , mockery , pingr , pkgdown , Rcpp (>= 0.10.0) , rhub (>= 1.0.2) , rmarkdown , spelling (>= 1.1) , whisker|
|imports||callr , cli , covr (>= 3.2.0) , crayon , desc , digest , DT , ellipsis (>= 0.3.0) , git2r (>= 0.23.0) , glue , httr (>= 0.4) , jsonlite , memoise (>= 1.0.0) , pkgbuild (>= 1.0.3) , pkgload (>= 1.0.2) , rcmdcheck (>= 1.3.3) , remotes (>= 2.1.0) , rlang , roxygen2 (>= 6.1.1) , rstudioapi (>= 0.7) , rversions , sessioninfo (>= 1.1.1) , stats , testthat (>= 2.1.1) , tools , utils , withr|
|depends||R (>= 3.0.2) , usethis (>= 1.5.0)|
|Contributors||RStudio, Hadley Wickham, Winston Chang, R Core team|
Include our badge in your README