usethis3.1.0 package

Automate Package and Project Setup

badges

README badges

browse-this

Visit important project-related web pages

create_from_github

Create a project from a GitHub repo

create_package

Create a package or project

edit_file

Open file for editing

edit

Open configuration files

git_branch_default

Deprecated Git functions

git_protocol

See or set the default Git protocol

git_sitrep

Git/GitHub sitrep

git_vaccinate

Vaccinate your global gitignore file

git-default-branch

Get or set the default Git branch

github-token

Get help with GitHub personal access tokens

issue-this

Helpers for GitHub issues

licenses

License a package

proj_activate

Activate a project

proj_sitrep

Report working directory and usethis/RStudio project

proj_utils

Utility functions for the active project

pull-requests

Helpers for GitHub pull requests

rename_files

Automatically rename paired R/ and test/ files

rprofile-helper

Helpers to make useful changes to .Rprofile

tidyverse

Helpers for tidyverse development

ui_silence

Suppress usethis's messaging

ui-legacy-functions

Legacy functions related to user interface

ui-questions

User interface - Questions

use_addin

Add minimal RStudio Addin binding

use_author

Add an author to the Authors@R field in DESCRIPTION

use_blank_slate

Don't save/load user workspace between sessions

use_build_ignore

Add files to .Rbuildignore

use_citation

Create a CITATION template

use_code_of_conduct

Add a code of conduct

use_course_details

Helpers to download and unpack a ZIP file

use_coverage

Test coverage

use_cpp11

Use C++ via the cpp11 package

use_cran_comments

CRAN submission comments

use_data_table

Prepare for importing data.table

use_data

Create package data

use_description

Create or modify a DESCRIPTION file

use_directory

Use a directory

use_git_config

Configure Git

use_git_hook

Add a git hook

use_git_ignore

Tell Git to ignore files

use_git_remote

Configure and report Git remotes

use_git

Initialise a git repository

use_github_action

Set up a GitHub Actions workflow

use_github_actions_badge

Generates a GitHub Actions badge

use_github_actions

Deprecated GitHub Actions functions

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_github

Connect a local repo with GitHub

use_gitlab_ci

Continuous integration setup and badges

use_import_from

Import a function from another package

use_jenkins

Create Jenkinsfile for Jenkins CI Pipelines

use_latest_dependencies

Use "latest" versions of all dependencies

use_lifecycle

Use lifecycle badges

use_logo

Use a package logo

use_make

Create Makefile

use_namespace

Use a basic NAMESPACE

use_news_md

Create a simple NEWS.md

use_package_doc

Package-level documentation

use_package

Depend on another package

use_pipe

Use magrittr's pipe in your package

use_pkgdown

Use pkgdown

use_r

Create or edit R or test files

use_rcpp

Use C, C++, RcppArmadillo, or RcppEigen

use_readme_rmd

Create README files

use_release_issue

Create a release checklist in a GitHub issue

use_revdep

Reverse dependency checks

use_rmarkdown_template

Add an RMarkdown Template

use_roxygen_md

Use roxygen2 with markdown

use_rscloud_badge

Deprecated badge function

use_rstudio_preferences

Set global RStudio preferences

use_rstudio

Add RStudio Project infrastructure

use_spell_check

Use spell check

use_standalone

Use a standalone file from another repo

use_template

Use a usethis-style template

use_test_helper

Create or edit a test helper file

use_testthat

Sets up overall testing infrastructure

use_tibble

Prepare to return a tibble

use_tidy_eval

Deprecated tidyverse functions

use_tidy_thanks

Identify contributors via GitHub activity

use_tutorial

Create a learnr tutorial

use_upkeep_issue

Create an upkeep checklist in a GitHub issue

use_version

Increment package version

use_vignette

Create a vignette or article

usethis_options

Options consulted by usethis

usethis-package

usethis: Automate Package and Project Setup

write-this

Write into or over a file

zip-utils

Download and unpack a ZIP file

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.

  • Maintainer: Jennifer Bryan
  • License: MIT + file LICENSE
  • Last published: 2024-11-26