Package index • 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 targeted 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_import_from(): Import a function from another package

use_r() use_test(): Create or edit R or test files

use_rmarkdown_template(): Add an RMarkdown Template

use_spell_check(): Use spell check

use_test_helper(): Create or edit a test helper file

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

use_author(): Add an author to the Authors@R field in DESCRIPTION

Package setup

Package setup tasks, typically performed once.

create_package() create_project(): Create a package or project

use_data_table(): Prepare for importing data.table

use_description() use_description_defaults(): Create or modify a DESCRIPTION file

use_mit_license() use_gpl_license() use_agpl_license() use_lgpl_license() use_apache_license() use_cc0_license() use_ccby_license() use_proprietary_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_rstudio_prefs() edit_git_config() edit_git_ignore() edit_pkgdown_config(): Open configuration files

use_build_ignore(): Add files to .Rbuildignore

use_cpp11(): Use C++ via the cpp11 package

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() questioning: Prepare to return a tibble

use_tidy_github_actions() create_tidy_package() use_tidy_description() use_tidy_dependencies() use_tidy_contributing() use_tidy_support() use_tidy_issue_template() use_tidy_coc() use_tidy_github() use_tidy_style() use_tidy_logo() use_tidy_upkeep_issue(): Helpers for tidyverse development

use_logo(): Use a package logo

use_news_md(): Create a simple NEWS.md

use_package_doc(): Package-level documentation

use_roxygen_md(): Use roxygen2 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() use_posit_cloud_badge(): README badges

use_gitlab_ci() use_circleci() use_circleci_badge() questioning: Continuous integration setup and badges

use_pkgdown() use_pkgdown_github_pages(): Use pkgdown

use_github_links(): Use GitHub links in URL and BugReports

use_lifecycle(): Use lifecycle badges

use_standalone(): Use a standalone file from another repo

use_testthat(): Sets up overall testing infrastructure

Package release

use_cran_comments(): CRAN submission comments

use_github_release(): Publish a GitHub release

use_release_issue(): Create a release checklist in a GitHub issue

use_revdep(): Reverse dependency checks

use_version() use_dev_version(): Increment package version

Continuous integration

use_github_action(): Set up a GitHub Actions workflow

use_gitlab_ci() use_circleci() use_circleci_badge() questioning: Continuous integration setup and badges

use_jenkins(): Create Jenkinsfile for Jenkins CI Pipelines

Tidyverse development

Conventions used in the tidyverse and r-lib organisations

use_tidy_github_actions() create_tidy_package() use_tidy_description() use_tidy_dependencies() use_tidy_contributing() use_tidy_support() use_tidy_issue_template() use_tidy_coc() use_tidy_github() use_tidy_style() use_tidy_logo() use_tidy_upkeep_issue(): Helpers for tidyverse development

use_github_labels() use_tidy_github_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 or RStudio or usethis, globally as a user or for a specific project

usethis_options: Options consulted by usethis

ui_silence(): Suppress usethis's messaging

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

edit_r_profile() edit_r_environ() edit_r_buildignore() edit_r_makevars() edit_rstudio_snippets() edit_rstudio_prefs() edit_git_config() edit_git_ignore() edit_pkgdown_config(): Open configuration files

Git and GitHub

create_from_github(): Create a project from a GitHub repo

use_git(): Initialise a git repository

use_github(): Connect a local repo with GitHub

use_github_action(): Set up a GitHub Actions workflow

use_github_file(): Copy a file from any GitHub repo into the current project

use_github_labels() use_tidy_github_labels() tidy_labels() tidy_labels_rename() tidy_label_colours() tidy_label_descriptions(): Manage GitHub issue labels

use_github_links(): Use GitHub links in URL and BugReports

use_github_pages(): Configure a GitHub Pages site

use_github_release(): Publish a GitHub release

git_sitrep(): Git/GitHub sitrep

create_github_token() gh_token_help(): Get help with GitHub personal access tokens

git_vaccinate(): Vaccinate your global gitignore file

use_git_config(): Configure Git

use_git_ignore(): Tell Git to ignore files

git_protocol() use_git_protocol(): See or set the default Git protocol

use_git_remote() git_remotes(): Configure and report Git remotes

use_git_hook(): Add a git hook

use_code_of_conduct(): Add a code of conduct

use_readme_rmd() use_readme_md(): Create README files

git_default_branch() git_default_branch_configure() git_default_branch_rediscover() git_default_branch_rename(): Get or set the default Git branch

browse_package() browse_project() browse_github() browse_github_issues() browse_github_pulls() browse_github_actions() browse_circleci() browse_cran(): Visit important project-related web pages

edit_r_profile() edit_r_environ() edit_r_buildignore() edit_r_makevars() edit_rstudio_snippets() edit_rstudio_prefs() edit_git_config() edit_git_ignore() edit_pkgdown_config(): Open configuration files

issue_close_community() issue_reprex_needed(): Helpers for GitHub issues

use_tidy_github_actions() create_tidy_package() use_tidy_description() use_tidy_dependencies() use_tidy_contributing() use_tidy_support() use_tidy_issue_template() use_tidy_coc() use_tidy_github() use_tidy_style() use_tidy_logo() use_tidy_upkeep_issue(): Helpers for tidyverse development

use_release_issue(): Create a release checklist in a GitHub issue

use_upkeep_issue(): Create an upkeep checklist in a GitHub issue

Pull requests

pr_init() pr_resume() pr_fetch() pr_push() pr_pull() pr_merge_main() pr_view() pr_pause() pr_finish() pr_forget(): Helpers for GitHub pull requests

Edit

edit_r_profile() edit_r_environ() edit_r_buildignore() edit_r_makevars() edit_rstudio_snippets() edit_rstudio_prefs() edit_git_config() edit_git_ignore() edit_pkgdown_config(): Open configuration files

rename_files(): Automatically rename paired R/ and test/ files

Browse

browse_package() browse_project() browse_github() browse_github_issues() browse_github_pulls() browse_github_actions() browse_circleci() browse_cran(): Visit important project-related web pages

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

use_rstudio_preferences(): Set global RStudio preferences

Deprecated functions

git_branch_default() deprecated: Deprecated Git functions

use_github_actions() use_github_action_check_release() use_github_action_check_standard() use_github_action_pr_commands() use_github_action_check_full() deprecated: Deprecated GitHub Actions functions

use_tidy_eval() deprecated: Deprecated tidyverse functions