usethis v1.3.0

0

Monthly downloads

0th

Percentile

Automate Package and Project Setup

Automate package and project setup tasks that are otherwise performed manually. This includes setting up unit testing, test coverage, continuous integration, Git, 'GitHub', licenses, 'Rcpp', 'RStudio' projects, and more.

Readme

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.

Functions in usethis

Name Description
use_git Initialise a git repository
use_directory Use a directory
browse_github_pat Create a GitHub personal access token
use_namespace Use a basic NAMESPACE
use_git_ignore Tell git to ignore files
use_rstudio Add RStudio Project infrastructure
use_roxygen_md Use roxygen with markdown
use_pkgdown Use pkgdown
use_github Connect a local repo with GitHub
use_r Create a new R file
use_package Depend on another package
use_template Use a usethis-style template
use_usethis Make usethis available in interactive sessions
use_testthat Create tests
badges README badges
use_version Increment package version
use_vignette Create a vignette
usethis-package usethis: Automate Package and Project Setup
ci Continuous integration setup and badges
use_code_of_conduct Add a code of conduct
use_course Download course materials
browse-this Quickly browse to important package webpages
use_cran_comments CRAN submission comments
use_course_details Download and unpack a ZIP file
use_revdep Reverse dependency checks
use_package_doc Package-level documentation
use_rmarkdown_template Add an RMarkdown Template
use_pipe Use magrittr's pipe in your package
use_git_hook Add a git hook
use_git_config Configure Git
use_readme_rmd Create README files
use_rcpp Use Rcpp
tidyverse Helpers for the tidyverse
proj_get Get and set the active project
edit Open useful configuration files
create_from_github Create a project from a GitHub repo
use_data Create package data
licenses License a package
use_blank_slate Don't save/load user workspace between sessions
use_description Create a default DESCRIPTION file for a package.
use_github_labels Manage GitHub issue labels
use_news_md Create a simple NEWS.md
use_build_ignore Add files to .Rbuildignore
create_package Create a package or project
No Results!

Last month downloads

Details

License GPL-3
URL https://github.com/r-lib/usethis
BugReports https://github.com/r-lib/usethis/issues
Encoding UTF-8
LazyData true
RoxygenNote 6.0.1.9000
NeedsCompilation no
Packaged 2018-02-24 00:13:53 UTC; jenny
Repository CRAN
Date/Publication 2018-02-24 21:53:51 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/usethis)](http://www.rdocumentation.org/packages/usethis)