usethis

<!-- badges: end -->

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_*()

proj_get()

proj_sitrep()

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.

✔

●

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 -------------------------------------------------
path  ✓ Creating '/tmp/RtmpBtK0Bx/mypkg/'
#> ✓ Setting active project to '/private/tmp/RtmpBtK0Bx/mypkg'
#> ✓ Creating 'R/'
#> ✓ Writing 'DESCRIPTION'
#> Package: mypkg
#> Title: What the Package Does (One Line, Title Case)
#> Version: 0.0.0.9000
#> [email protected] (parsed):
#>     * First Last <first.last> [aut, cre] (YOUR-ORCID-ID)
#> Description: What the package does (one paragraph).
#> License: use_mit_license(), use_gpl3_license() or friends to pick a
#>     license
#> Encoding: UTF-8
#> LazyData: true
#> Roxygen: list(markdown = TRUE)
#> RoxygenNote: 7.1.1
#> ✓ Writing 'NAMESPACE'
#> ✓ Setting active project to ''
only needed since this session isn't interactive
proj_activate(path)
#> ✓ Setting active project to '/private/tmp/RtmpBtK0Bx/mypkg'
#> ✓ Changing working directory to '/tmp/RtmpBtK0Bx/mypkg/'
Modify the description ----------------------------------------------
use_mit_license("My Name")
#> ✓ Setting License field in DESCRIPTION to 'MIT + file LICENSE'
#> ✓ Writing 'LICENSE'
#> ✓ Writing 'LICENSE.md'
#> ✓ Adding '^LICENSE\.md$' to '.Rbuildignore'
use_package("MASS", "Suggests")
#> ✓ Adding 'MASS' to Suggests field in DESCRIPTION
#> ● Use requireNamespace("MASS", quietly = TRUE) to test if package is installed
#> ● Then directly refer to functons like MASS::fun() (replacing fun()).
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
#> ✓ Setting Config/testthat/edition field in DESCRIPTION to '3'
#> ✓ Creating 'tests/testthat/'
#> ✓ Writing 'tests/testthat.R'
#> ✓ Writing 'tests/testthat/test-my-test.R'
#> ● Edit 'tests/testthat/test-my-test.R'
x  ✓ Adding 'R' to Depends field in DESCRIPTION
#> ✓ Creating 'data/'
#> ✓ Saving 'x', 'y' to 'data/x.rda', 'data/y.rda'
#> ● Document your data (see 'https://r-pkgs.org/data.html')
Use git ------------------------------------------------------------
use_git()
#> ✓ Initialising Git repo
#> ✓ Adding '.Rproj.user', '.Rhistory', '.Rdata', '.httr-oauth', '.DS_Store' to '.gitignore'
</first.last>

Code of Conduct

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.