# Automate Package and Project Setup

## Documentation for package ‘usethis’ version 3.1.0

- DESCRIPTION file.
- Package NEWS.

## Help Pages

B C E G I L P R T U W Z

## -- B --

badges | README badges
browse-this | Visit important project-related web pages
browse_circleci | Visit important project-related web pages
browse_cran | Visit important project-related web pages
browse_github | Visit important project-related web pages
browse_github_actions | Visit important project-related web pages
browse_github_issues | Visit important project-related web pages
browse_github_pulls | Visit important project-related web pages
browse_package | Visit important project-related web pages
browse_project | Visit important project-related web pages

## -- C --

create_from_github | Create a project from a GitHub repo
create_github_token | Get help with GitHub personal access tokens
create_package | Create a package or project
create_project | Create a package or project
create_tidy_package | Helpers for tidyverse development

## -- E --

edit | Open configuration files
edit_git_config | Open configuration files
edit_git_ignore | Open configuration files
edit_pkgdown_config | Open configuration files
edit_rstudio_prefs | Open configuration files
edit_rstudio_snippets | Open configuration files
edit_r_buildignore | Open configuration files
edit_r_environ | Open configuration files
edit_r_makevars | Open configuration files
edit_r_profile | Open configuration files

## -- G --

gh_token_help | Get help with GitHub personal access tokens
git-default-branch | Get or set the default Git branch
github-token | Get help with GitHub personal access tokens
git_default_branch | Get or set the default Git branch
git_default_branch_configure | Get or set the default Git branch
git_default_branch_rediscover | Get or set the default Git branch
git_default_branch_rename | Get or set the default Git branch
git_protocol | See or set the default Git protocol
git_remotes | Configure and report Git remotes
git_sitrep | Git/GitHub sitrep
git_vaccinate | Vaccinate your global gitignore file

## -- I --

issue-this | Helpers for GitHub issues
issue_close_community | Helpers for GitHub issues
issue_reprex_needed | Helpers for GitHub issues

## -- L --

local_project | Utility functions for the active project

## -- P --

proj_activate | Activate a project
proj_get | Utility functions for the active project
proj_path | Utility functions for the active project
proj_set | Utility functions for the active project
proj_sitrep | Report working directory and usethis/RStudio project
proj_utils | Utility functions for the active project
pr_fetch | Helpers for GitHub pull requests
pr_finish | Helpers for GitHub pull requests
pr_forget | Helpers for GitHub pull requests
pr_init | Helpers for GitHub pull requests
pr_merge_main | Helpers for GitHub pull requests
pr_pause | Helpers for GitHub pull requests
pr_pull | Helpers for GitHub pull requests
pr_push | Helpers for GitHub pull requests
pr_resume | Helpers for GitHub pull requests
pr_view | Helpers for GitHub pull requests
pull-requests | Helpers for GitHub pull requests

## -- R --

rename_files | Automatically rename paired R/ and test/ files
rprofile-helper | Helpers to make useful changes to '.Rprofile'

## -- T --

tidyverse | Helpers for tidyverse development
tidy_labels | Manage GitHub issue labels
tidy_labels_rename | Manage GitHub issue labels
tidy_label_colours | Manage GitHub issue labels
tidy_label_descriptions | Manage GitHub issue labels

## -- U --

ui_silence | Suppress usethis's messaging
usethis_options | Options consulted by usethis
use_addin | Add minimal RStudio Addin binding
use_agpl3_license | License a package
use_agpl_license | License a package
use_apache_license | License a package
use_apl2_license | License a package
use_article | Create a vignette or article
use_author | Add an author to the 'Authors@R' field in DESCRIPTION
use_badge | README badges
use_binder_badge | README badges
use_bioc_badge | README badges
use_blank_slate | Don't save/load user workspace between sessions
use_build_ignore | Add files to '.Rbuildignore'
use_c | Use C, C++, RcppArmadillo, or RcppEigen
use_cc0_license | License a package
use_ccby_license | License a package
use_circleci | Continuous integration setup and badges
use_circleci_badge | Continuous integration setup and badges
use_citation | Create a CITATION template
use_code_of_conduct | Add a code of conduct
use_conflicted | Helpers to make useful changes to '.Rprofile'
use_course | Download and unpack a ZIP file
use_coverage | Test coverage
use_covr_ignore | Test coverage
use_cpp11 | Use C++ via the cpp11 package
use_cran_badge | README badges
use_cran_comments | CRAN submission comments
use_data | Create package data
use_data_raw | Create package data
use_data_table | Prepare for importing data.table
use_description | Create or modify a DESCRIPTION file
use_description_defaults | Create or modify a DESCRIPTION file
use_devtools | Helpers to make useful changes to '.Rprofile'
use_dev_package | Depend on another package
use_dev_version | Increment package version
use_directory | Use a directory
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 | 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
use_gitlab_ci | Continuous integration setup and badges
use_git_config | Configure Git
use_git_hook | Add a git hook
use_git_ignore | Tell Git to ignore files
use_git_protocol | See or set the default Git protocol
use_git_remote | Configure and report Git remotes
use_gpl3_license | License a package
use_gpl_license | License a package
use_import_from | Import a function from another package
use_jenkins | Create Jenkinsfile for Jenkins CI Pipelines
use_lgpl_license | License a package
use_lifecycle | Use lifecycle badges
use_lifecycle_badge | README badges
use_logo | Use a package logo
use_make | Create Makefile
use_mit_license | License a package
use_namespace | Use a basic 'NAMESPACE'
use_news_md | Create a simple 'NEWS.md'
use_package | Depend on another package
use_package_doc | Package-level documentation
use_partial_warnings | Helpers to make useful changes to '.Rprofile'
use_pipe | Use magrittr's pipe in your package
use_pkgdown | Use pkgdown
use_pkgdown_github_pages | Use pkgdown
use_posit_cloud_badge | README badges
use_proprietary_license | License a package
use_r | Create or edit R or test files
use_rcpp | Use C, C++, RcppArmadillo, or RcppEigen
use_rcpp_armadillo | Use C, C++, RcppArmadillo, or RcppEigen
use_rcpp_eigen | Use C, C++, RcppArmadillo, or RcppEigen
use_readme_md | Create README files
use_readme_rmd | Create README files
use_release_issue | Create a release checklist in a GitHub issue
use_reprex | Helpers to make useful changes to '.Rprofile'
use_revdep | Reverse dependency checks
use_rmarkdown_template | Add an RMarkdown Template
use_roxygen_md | Use roxygen2 with markdown
use_rstudio | Add RStudio Project infrastructure
use_rstudio_preferences | Set global RStudio preferences
use_spell_check | Use spell check
use_standalone | Use a standalone file from another repo
use_template | Use a usethis-style template
use_test | Create or edit R or test files
use_testthat | Sets up overall testing infrastructure
use_test_helper | Create or edit a test helper file
use_tibble | Prepare to return a tibble
use_tidy_coc | Helpers for tidyverse development
use_tidy_contributing | Helpers for tidyverse development
use_tidy_dependencies | Helpers for tidyverse development
use_tidy_description | Helpers for tidyverse development
use_tidy_github | Helpers for tidyverse development
use_tidy_github_actions | Helpers for tidyverse development
use_tidy_github_labels | Manage GitHub issue labels
use_tidy_issue_template | Helpers for tidyverse development
use_tidy_logo | Helpers for tidyverse development
use_tidy_style | Helpers for tidyverse development
use_tidy_support | Helpers for tidyverse development
use_tidy_thanks | Identify contributors via GitHub activity
use_tidy_upkeep_issue | Helpers for tidyverse development
use_tutorial | Create a learnr tutorial
use_upkeep_issue | Create an upkeep checklist in a GitHub issue
use_usethis | Helpers to make useful changes to '.Rprofile'
use_version | Increment package version
use_vignette | Create a vignette or article
use_zip | Download and unpack a ZIP file

## -- W --

with_project | Utility functions for the active project

## -- Z --

zip-utils | Download and unpack a ZIP file