/usethis

Set up commonly used πŸ“¦ components

Primary LanguageRGNU General Public License v3.0GPL-3.0

usethis

Travis build status AppVeyor Build Status Coverage status CRAN status lifecycle

The goal of usethis is to automate many common package and analysis setup tasks.

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. If you’ve just used usethis to create a new package or project, that will be the current project. Otherwise usethis tries to confirm that current working directory can be recognized as a project. Use proj_get() and proj_set() for manual intervention. Some 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.

Note: usethis is gaining more and more functionality for analytical project that are not packages. Stay tuned.

library(usethis)

# Create a new package -------------------------------------------------
tmp <- file.path(tempdir(), "mypkg")
create_package(tmp)
#> Changing active project to 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
#> ● Refer to functions with `callr::fun()`
#> βœ” Adding 'r-lib/callr' to DESCRIPTION Remotes

# Set up various packages ---------------------------------------------
use_roxygen_md()
#> βœ” Setting Roxygen field in DESCRIPTION to 'list(markdown = TRUE)'
#> βœ” Setting RoxygenNote field in DESCRIPTION to '6.0.1.9000'
#> ● Re-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 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'
#> ● Edit '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'
#> ● Edit 'test-my-test.R'

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

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

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.