Create

Create a project de novo or from an existing source, either local or remote

create_from_github()

Create a project from a GitHub repo

create_package() create_project()

Create a package or project

use_course()

Download course materials

Active project

Query or set the project targetted by usethis functions that don’t take a path

proj_sitrep()

Report working directory and usethis/RStudio project

proj_get() proj_set() proj_path()

Utility functions for the active project

Package development

Add or modify files typically found in R packages

create_package() create_project()

Create a package or project

use_description() use_description_defaults()

Create or modify a DESCRIPTION file

use_mit_license() use_gpl3_license() use_apl2_license() use_cc0_license()

License a package

use_package() use_dev_package()

Depend on another package

use_namespace()

Use a basic NAMESPACE

use_r()

Create or edit a .R file

use_testthat() use_test()

Create tests

use_spell_check()

Use spell check

use_data() use_data_raw()

Create package data

use_travis() use_coverage() use_appveyor()

Continuous integration setup and badges

use_build_ignore()

Add files to .Rbuildignore

use_pipe()

Use magrittr's pipe in your package

use_rcpp()

Use Rcpp

use_tibble()

Prepare to return a tibble

use_logo()

Use a package logo

use_news_md()

Create a simple NEWS.md

use_package_doc()

Package-level documentation

use_roxygen_md()

Use roxygen with markdown

use_vignette()

Create a vignette

use_readme_rmd() use_readme_md()

Create README files

use_badge() use_cran_badge() use_bioc_badge() use_lifecycle_badge() use_binder_badge()

README badges

use_pkgdown()

Use pkgdown

use_cran_comments()

CRAN submission comments

use_revdep()

Reverse dependency checks

use_version() use_dev_version()

Increment package version

use_rmarkdown_template()

Add an RMarkdown Template

use_tidy_ci() use_tidy_description() use_tidy_versions() use_tidy_eval() use_tidy_contributing() use_tidy_issue_template() use_tidy_support() use_tidy_coc() use_tidy_github() use_tidy_style()

Helpers for tidyverse development

use_tidy_thanks()

Identify contributors via GitHub activity

use_github_links()

Use GitHub links in URL and BugReports

Configuration

Configure the behaviour of R, RStudio, or Git, globally as a user or for a specific project

use_blank_slate()

Don't save/load user workspace between sessions

use_usethis()

Make usethis available in interactive sessions

use_git_config()

Configure Git

edit_r_profile() edit_r_environ() edit_r_makevars() edit_rstudio_snippets() edit_git_config() edit_git_ignore()

Open configuration files

Git and GitHub

create_from_github()

Create a project from a GitHub repo

use_git_config()

Configure Git

use_git()

Initialise a git repository

use_github()

Connect a local repo with GitHub

use_github_links()

Use GitHub links in URL and BugReports

use_git_ignore()

Tell git to ignore files

use_git_hook()

Add a git hook

use_github_labels() tidy_labels()

Manage GitHub issue labels

use_code_of_conduct()

Add a code of conduct

use_readme_rmd() use_readme_md()

Create README files

browse_github() browse_github_issues() browse_github_pulls() browse_travis() browse_cran()

Quickly browse to important package webpages

browse_github_pat()

Create a GitHub personal access token

edit_r_profile() edit_r_environ() edit_r_makevars() edit_rstudio_snippets() edit_git_config() edit_git_ignore()

Open configuration files

Edit

edit_r_profile() edit_r_environ() edit_r_makevars() edit_rstudio_snippets() edit_git_config() edit_git_ignore()

Open configuration files

Browse

browse_github() browse_github_issues() browse_github_pulls() browse_travis() browse_cran()

Quickly browse to important package webpages

browse_github_pat()

Create a GitHub personal access token

Helpers

These functions are mostly for internal use. But they are useful for those who wish to offer usethis-like support for, e.g., workflows specific to an organisation.

use_template()

Use a usethis-style template

use_directory()

Use a directory

use_rmarkdown_template()

Add an RMarkdown Template

use_rstudio()

Add RStudio Project infrastructure