Function reference • usethis

Create Create a project de novo or from an existing source, either local or remote
`create_package()` `create_project()`	Create a package or project
`create_from_github()`	Create a project from a GitHub repo
`use_course()` `use_zip()`	Download and unpack a ZIP file
Active project Query or set the project targetted by usethis functions that don’t take a path
`proj_activate()`	Activate a project
`proj_sitrep()`	Report working directory and usethis/RStudio project
`proj_get()` `proj_set()` `proj_path()` `with_project()` `local_project()`	Utility functions for the active project
Package development Add or modify files typically found in R packages
`use_data()` `use_data_raw()`	Create package data
`use_package()` `use_dev_package()`	Depend on another package
`use_r()`	Create or edit a .R file
`use_rmarkdown_template()`	Add an RMarkdown Template
`use_spell_check()`	Use spell check
`use_testthat()` `use_test()`	Create tests
`use_vignette()` `use_article()`	Create a vignette or article.
`use_addin()`	Add minimal RStudio Addin binding
`use_citation()`	Create a CITATION template
`use_tutorial()`	Create a learnr tutorial
Package setup Package setup tasks, typically performed once.
`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_lgpl_license()` `use_apl2_license()` `use_cc0_license()` `use_ccby_license()`	License a package
`use_namespace()`	Use a basic `NAMESPACE`
`use_coverage()` `use_covr_ignore()`	Test coverage
`edit_r_profile()` `edit_r_environ()` `edit_r_buildignore()` `edit_r_makevars()` `edit_rstudio_snippets()` `edit_git_config()` `edit_git_ignore()`	Open configuration files
`use_build_ignore()`	Add files to `.Rbuildignore`
`use_make()`	Create Makefile
`use_pipe()`	Use magrittr's pipe in your package
`use_rcpp()` `use_rcpp_armadillo()` `use_rcpp_eigen()` `use_c()`	Use C, C++, RcppArmadillo, or RcppEigen
`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_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_travis()`	Use pkgdown
`use_github_links()`	Use GitHub links in URL and BugReports
Package release
`create_tidy_package()` `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()` `use_tidy_release_test_env()`	Helpers for tidyverse development
`use_github_release()`	Draft a GitHub release
`use_release_issue()`	Create a release issue checklist
`use_cran_comments()`	CRAN submission comments
`use_revdep()`	Reverse dependency checks
`use_version()` `use_dev_version()`	Increment package version
Continuous integration
`use_travis()` `use_appveyor()` `use_gitlab_ci()` `use_circleci()`	Continuous integration setup and badges
`use_jenkins()`	Create Jenkinsfile for Jenkins CI Pipelines
Tidyverse development Conventions used in the tidyverse and r-lib organisations
`create_tidy_package()` `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()` `use_tidy_release_test_env()`	Helpers for tidyverse development
`use_github_labels()` `use_tidy_labels()` `tidy_labels()` `tidy_labels_rename()` `tidy_label_colours()` `tidy_label_descriptions()`	Manage GitHub issue labels
`use_tidy_thanks()`	Identify contributors via GitHub activity
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_conflicted()` `use_reprex()` `use_usethis()` `use_devtools()` `use_partial_warnings()`	Helpers to make useful changes to `.Rprofile`
`use_git_config()`	Configure Git
`edit_r_profile()` `edit_r_environ()` `edit_r_buildignore()` `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
`git_protocol()` `use_git_protocol()`	Produce or register git protocol
`use_git_remote()` `git_remotes()`	Configure and report Git remotes
`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()` `use_tidy_labels()` `tidy_labels()` `tidy_labels_rename()` `tidy_label_colours()` `tidy_label_descriptions()`	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_token()` `browse_github_pat()` `github_token()`	Create and retrieve a GitHub personal access token
`edit_r_profile()` `edit_r_environ()` `edit_r_buildignore()` `edit_r_makevars()` `edit_rstudio_snippets()` `edit_git_config()` `edit_git_ignore()`	Open configuration files
`git_credentials()` `use_git_credentials()`	Produce or register git credentials
`git_sitrep()`	git/GitHub sitrep
`git_vaccinate()`	Vaccinate your global git ignore
Pull requests
`pr_init()` `pr_fetch()` `pr_push()` `pr_pull()` `pr_pull_upstream()` `pr_sync()` `pr_view()` `pr_pause()` `pr_finish()`	Helpers for GitHub pull requests
Edit
`edit_r_profile()` `edit_r_environ()` `edit_r_buildignore()` `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_token()` `browse_github_pat()` `github_token()`	Create and retrieve 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

Reference

Create

Active project

Package development

Package setup

Package release

Continuous integration

Tidyverse development

Configuration

Git and GitHub

Pull requests

Edit

Browse

Helpers

Contents