{"Package":"devtools","Title":"Tools to Make Developing R Packages Easier","Version":"2.2.2","Authors@R":"c(\nperson(\"Hadley\", \"Wickham\", role = \"aut\"),\nperson(\"Jim\", \"Hester\", , \"jim.hester@rstudio.com\", role = c(\"aut\", \"cre\")),\nperson(\"Winston\", \"Chang\", role = \"aut\"),\nperson(\"RStudio\", role = \"cph\"),\nperson(\"R Core team\", role = \"ctb\",\ncomment = \"Some namespace and vignette code extracted from base R\")\n)","Description":"Collection of package development tools.","License":"GPL (>= 2)","URL":"https://devtools.r-lib.org/, https://github.com/r-lib/devtools","BugReports":"https://github.com/r-lib/devtools/issues","Depends":"R (>= 3.0.2), usethis (>= 1.5.0)","Imports":"callr, cli, covr (>= 3.2.0), crayon, desc, digest, DT,\nellipsis (>= 0.3.0), glue, git2r (>= 0.23.0), httr (>= 0.4),\njsonlite, memoise (>= 1.0.0), pkgbuild (>= 1.0.3), pkgload (>=\n1.0.2), rcmdcheck (>= 1.3.3), remotes (>= 2.1.1), rlang,\nroxygen2 (>= 6.1.1), rstudioapi (>= 0.7), rversions,\nsessioninfo (>= 1.1.1), stats, testthat (>= 2.1.1), tools,\nutils, withr","Suggests":"BiocManager, bitops, curl (>= 0.9), evaluate, foghorn (>=\n1.1.0), gmailr (> 0.7.0), knitr, lintr (>= 0.2.1), mockery,\npingr, MASS, pkgdown, Rcpp (>= 0.10.0), rhub (>= 1.0.2),\nrmarkdown, spelling (>= 1.1), whisker","VignetteBuilder":"knitr","Encoding":"UTF-8","RoxygenNote":"7.0.2","Language":"en-US","NeedsCompilation":"no","Packaged":"2020-02-17 15:07:25 UTC; jhester","Author":"Hadley Wickham [aut],\nJim Hester [aut, cre],\nWinston Chang [aut],\nRStudio [cph],\nR Core team [ctb] (Some namespace and vignette code extracted from base\nR)","Maintainer":"Jim Hester ","Repository":"CRAN","Date/Publication":"2020-02-17 20:30:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/devtools_2.2.2.tar.gz","jsonAuthors":[{"name":"Hadley Wickham","email":null,"maintainer":false},{"name":"Jim Hester","email":"jim.hester@rstudio.com","maintainer":true},{"name":"Winston Chang","email":null,"maintainer":false},{"name":"RStudio ","email":null,"maintainer":false},{"name":"R Core team ","email":null,"maintainer":false}],"readme":"# devtools

\n\n[![Build Status](https://travis-ci.org/r-lib/devtools.svg?branch=master)](https://travis-ci.org/r-lib/devtools)\n[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/r-lib/devtools?branch=master&svg=true)](https://ci.appveyor.com/project/hadley/devtools)\n[![Coverage Status](https://codecov.io/github/r-lib/devtools/coverage.svg?branch=master)](https://codecov.io/github/r-lib/devtools?branch=master)\n[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/devtools)](https://cran.r-project.org/package=devtools)\n\nThe aim of devtools is to make package development easier by providing R\nfunctions that simplify and expedite common tasks. [R\nPackages](http://r-pkgs.had.co.nz/) is a book based around this workflow.\n\n## Installation\n\n```r\n# Install devtools from CRAN\ninstall.packages(\"devtools\")\n\n# Or the development version from GitHub:\n# install.packages(\"devtools\")\ndevtools::install_github(\"r-lib/devtools\")\n```\n\n## Cheatsheet\n\n

\n\n## Usage\n\nAll devtools functions accept a path as an argument, e.g.\n`load_all(\"path/to/mypkg\")`. If you don't specify a path, devtools will\nlook in the current working directory - this is recommended practice.\n\n### Frequent development tasks:\n\n* `load_all()` simulates installing and reloading your package, loading R code\n in `R/`, compiled shared objects in `src/` and data files in `data/`. During\n development you usually want to access all functions (even un-exported\n internal ones) so `load_all()` works as if all functions were exported in the\n package `NAMESPACE`.\n\n* `document()` updates generated documentation in `man/`, file collation and\n `NAMESPACE`.\n\n* `test()` reloads your code with `load_all()`, then runs all `testthat` tests.\n\n* `test_coverage()` runs test coverage on your package with\n [covr](https://github.com/r-lib/covr). This makes it easy to see what parts of your\n package could use more tests!\n\n### Building and installing:\n\n* `install()` reinstalls the package, detaches the currently loaded version\n then reloads the new version with `library()`. Reloading a package is not\n guaranteed to work: see the documentation for `unload()` for caveats.\n\n* `build()` builds a package file from package sources. You can use it to build\n a binary version of your package.\n\n* `install_*` functions install an R package:\n * `install_github()` from GitHub\n * `install_gitlab()` from GitLab\n * `install_bitbucket()` from Bitbucket\n * `install_url()` from an arbitrary url\n * `install_git()` and `install_svn()` from an arbitrary git or SVN repository\n * `install_local()` from a local file on disk\n * `install_version()` from a specific version on CRAN\n\n* `update_packages()` updates a package to the latest version. This works\n both on packages installed from CRAN as well as those installed from any of\n the `install_*` functions.\n\n### Check and release:\n\n* `check()` updates the documentation, then builds and checks the package locally.\n `check_win()` checks a package using\n [win-builder](http://win-builder.r-project.org/), and `check_rhub()` checks a package using\n [r-hub](http://log.r-hub.io/). This allows you to easily check\n your package on all systems CRAN uses before submission.\n\n* `release()` makes sure everything is ok with your package (including asking\n you a number of questions), then builds and uploads to CRAN.\n\n## Learning more\n\nR package development can be intimidating, however there are now a number of\nvaluable resources to help!\n\n

\n\n1. R Packages is a book that gives a comprehensive treatment of all common parts\n of package development and uses devtools throughout.\n * The first edition is available at , but note that\n it has grown somewhat out of sync with the current version of devtools.\n * A second edition is under development and is evolving to reflect the\n current state of devtools. It is available at .\n * The [Whole Game](http://r-pkgs.org/whole-game.html) and\n [Package structure](http://r-pkgs.org/package-structure-state.html) chapters\n make great places to start.\n\n2. [RStudio community - package\n development](https://community.rstudio.com/c/package-development)\n is a great place to ask specific questions related to package development.\n\n3. [rOpenSci packages](https://ropensci.github.io/dev_guide/) has\n extensive documentation on best practices for R packages looking to be\n contributed to rOpenSci, but also very useful general recommendations\n for package authors.\n\n4. There are a number of fantastic blog posts on writing your first package, including\n - [Writing an R package from scratch - Hilary Parker](https://hilaryparker.com/2014/04/29/writing-an-r-package-from-scratch/)\n - [How to develop good R packages - Maëlle Salmon](http://www.masalmon.eu/2017/12/11/goodrpackages/)\n - [Making your first R package - Fong Chun Chan](http://tinyheero.github.io/jekyll/update/2015/07/26/making-your-first-R-package.html)\n - [Writing an R package from scratch - Tomas Westlake](https://r-mageddon.netlify.com/post/writing-an-r-package-from-scratch/)\n\n5. [Writing R\n Extensions](https://cran.r-project.org/doc/manuals/r-release/R-exts.html) is\n the exhaustive, canonical reference for writing R packages, maintained by\n the R core developers.\n\n## Conscious uncoupling\n\ndevtools started off as a lean-and-mean package to facilitate local package\ndevelopment, but over the years it accumulated more and more functionality.\ndevtools has undergone a [conscious\nuncoupling](https://web.archive.org/web/20140326060230/http://www.goop.com/journal/be/conscious-uncoupling)\nto split out functionality into smaller, more tightly focussed packages. This\nincludes:\n\n* [testthat](https://github.com/r-lib/testthat): Writing and running tests\n (i.e. `test()`).\n\n* [roxygen2](https://github.com/klutometis/roxygen): Function and package documentation\n (i.e. `document()`).\n\n* [remotes](https://github.com/r-lib/remotes): Installing packages (i.e.\n `install_github()`).\n\n* [pkgbuild](https://github.com/r-lib/pkgbuild): Building binary packages\n (including checking if build tools are available) (i.e. `build()`).\n\n* [pkgload](https://github.com/r-lib/pkgload): Simulating package loading (i.e.\n `load_all()`).\n\n* [rcmdcheck](https://github.com/r-lib/rcmdcheck): Running R CMD check and\n reporting the results (i.e. `check()`).\n\n* [revdepcheck](https://github.com/r-lib/revdepcheck): Running R CMD check on\n all reverse dependencies, and figuring out what's changed since the last CRAN\n release (i.e. `revdep_check()`).\n\n* [sessioninfo](https://github.com/r-lib/sessioninfo): R session info (i.e.\n `session_info()`).\n\n* [usethis](https://github.com/r-lib/usethis): Automating package setup (i.e.\n `use_test()`).\n\nGenerally, you should not need to worry about these different packages, because\ndevtools installs them all automatically. You will need to care, however, if\nyou're filing a bug because reporting it at the correct place will lead to a\nspeedier resolution.\n\nYou also may need to care if you are trying to use some devtools functionality\nin your own package or deployed application. Generally in these cases it\nis better to depend on the particular package directly rather than depend on devtools,\ne.g. use `sessioninfo::session_info()` rather than `devtools::session_info()`,\nor `remotes::install_github()` vs `devtools::install_github()`.\n\nHowever for day to day development we recommend you continue to use\n`library(devtools)` to quickly load all needed development tools, just like\n`library(tidyverse)` quickly loads all the tools necessary for data exploration\nand visualization.\n\n## Code of conduct\n\nPlease note that the devtools project is released with a [Contributor Code of Conduct](https://github.com/r-lib/devtools/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.","jobInfo":{"package":"devtools","version":"2.2.2","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-04-11T01:29:47+0000"}}

Description

Usage

Arguments

Examples