Set up commonly used πŸ“¦ components
Clone or download
jennybc Tweak various URLs
Make them https or better align with URL suggested by the provider
Latest commit 1e3c6a6 Sep 22, 2018

README.md

usethis

Travis build status AppVeyor Build Status Coverage status CRAN status lifecycle

usethis is a workflow package: it automates repetitive tasks that arise during project setup and development, both for R packages and non-package projects.

Installation

Install the released version of usethis from CRAN:

install.packages("usethis")

Or install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("r-lib/usethis")

Usage

Most use_*() functions operate on the active project: literally, a directory on your computer. If you’ve just used usethis to create a new package or project, that will be the active project. Otherwise, usethis verifies that current working directory is or is below a valid project directory and that becomes the active project. Use proj_get() or proj_sitrep() to manually query the project and read more in the docs.

A few usethis functions have no strong connections to projects and will expect you to provide a path.

usethis is quite chatty, explaining what it’s doing and assigning you tasks. βœ” indicates something usethis has done for you. ● indicates that you’ll need to do some work yourself.

Below is a quick look at how usethis can help to set up a package. But remember, many usethis functions are also applicable to analytical projects that are not packages.

library(usethis)

# Create a new package -------------------------------------------------
tmp <- file.path(tempdir(), "mypkg")
create_package(tmp)
#> βœ” Setting active project to '/private/var/folders/vr/gzrbtprx6ybg85y5pvwm1ct40000gn/T/RtmpGwzXO5/mypkg'
#> βœ” Creating 'R/'
#> βœ” Creating 'man/'
#> βœ” Writing 'DESCRIPTION'
#> βœ” Writing 'NAMESPACE'

# Modify the description ----------------------------------------------
use_mit_license("My Name")
#> βœ” Setting License field in DESCRIPTION to 'MIT + file LICENSE'
#> βœ” Writing 'LICENSE.md'
#> βœ” Adding '^LICENSE\\.md$' to '.Rbuildignore'
#> βœ” Writing 'LICENSE'

use_package("MASS", "Suggests")
#> βœ” Adding 'MASS' to Suggests field in DESCRIPTION
#> ● Use `requireNamespace("MASS", quietly = TRUE)` to test if package is installed
#> ● Then use `MASS::fun()` to refer to functions.

use_dev_package("callr")
#> βœ” Adding 'callr' to Imports field in DESCRIPTION
#> βœ” Adding 'r-lib/callr' to Remotes field in DESCRIPTION

# Set up various packages ---------------------------------------------
use_roxygen_md()
#> βœ” Setting Roxygen field in DESCRIPTION to 'list(markdown = TRUE)'
#> βœ” Setting RoxygenNote field in DESCRIPTION to '6.1.0'
#> ● Run `devtools::document()`

use_rcpp()
#> βœ” Adding 'Rcpp' to LinkingTo field in DESCRIPTION
#> βœ” Adding 'Rcpp' to Imports field in DESCRIPTION
#> βœ” Creating 'src/'
#> βœ” Adding '*.o', '*.so', '*.dll' to 'src/.gitignore'
#> ● Include the following roxygen tags somewhere in your package
#>   #' @useDynLib mypkg, .registration = TRUE
#>   #' @importFrom Rcpp sourceCpp
#>   NULL
#> ● Run `devtools::document()`

use_revdep()
#> βœ” Creating 'revdep/'
#> βœ” Adding '^revdep$' to '.Rbuildignore'
#> βœ” Adding 'checks', 'library', 'checks.noindex', 'library.noindex', 'data.sqlite', '*.html' to 'revdep/.gitignore'
#> βœ” Writing 'revdep/email.yml'
#> ● Run checks with `revdepcheck::revdep_check(num_workers = 4)`

# Set up other files -------------------------------------------------
use_readme_md()
#> βœ” Writing 'README.md'

use_news_md()
#> βœ” Writing 'NEWS.md'

use_test("my-test")
#> βœ” Adding 'testthat' to Suggests field in DESCRIPTION
#> βœ” Creating 'tests/testthat/'
#> βœ” Writing 'tests/testthat.R'
#> βœ” Writing 'tests/testthat/test-my-test.R'

x <- 1
y <- 2
use_data(x, y)
#> βœ” Creating 'data/'
#> βœ” Saving 'x', 'y' to 'data/x.rda', 'data/y.rda'

# Use git ------------------------------------------------------------
use_git()
#> βœ” Initialising Git repo
#> βœ” Adding '.Rhistory', '.RData', '.Rproj.user' to '.gitignore'

Please note that the usethis project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.