Automate Package and Project Setup


[Up] [Top]

Documentation for package ‘usethis’ version 1.4.0

Help Pages

badges README badges
browse-this Quickly browse to important package webpages
browse_cran Quickly browse to important package webpages
browse_github Quickly browse to important package webpages
browse_github_issues Quickly browse to important package webpages
browse_github_pat Create a GitHub personal access token
browse_github_pulls Quickly browse to important package webpages
browse_travis Quickly browse to important package webpages
create_from_github Create a project from a GitHub repo
create_package Create a package or project
create_project Create a package or project
edit Open configuration files
edit_git_config Open configuration files
edit_git_ignore Open configuration files
edit_rstudio_snippets Open configuration files
edit_r_environ Open configuration files
edit_r_makevars Open configuration files
edit_r_profile Open configuration files
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
tidyverse Helpers for tidyverse development
tidy_labels Manage GitHub issue labels
use_apl2_license License a package
use_appveyor Continuous integration setup and badges
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_cc0_license License a package
use_code_of_conduct Add a code of conduct
use_course Download course materials
use_coverage Continuous integration setup and badges
use_cran_badge README badges
use_cran_comments CRAN submission comments
use_data Create package data
use_data_raw Create package data
use_description Create or modify a DESCRIPTION file
use_description_defaults Create or modify a DESCRIPTION file
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_labels Manage GitHub issue labels
use_github_links Use GitHub links in URL and BugReports
use_git_config Configure Git
use_git_hook Add a git hook
use_git_ignore Tell git to ignore files
use_gpl3_license License a package
use_lifecycle_badge README badges
use_logo Use a package logo
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_pipe Use magrittr's pipe in your package
use_pkgdown Use pkgdown
use_r Create or edit a .R file
use_rcpp Use Rcpp
use_readme_md Create README files
use_readme_rmd Create README files
use_revdep Reverse dependency checks
use_rmarkdown_template Add an RMarkdown Template
use_roxygen_md Use roxygen with markdown
use_rstudio Add RStudio Project infrastructure
use_spell_check Use spell check
use_template Use a usethis-style template
use_test Create tests
use_testthat Create tests
use_tibble Prepare to return a tibble
use_tidy_ci Helpers for tidyverse development
use_tidy_coc Helpers for tidyverse development
use_tidy_contributing Helpers for tidyverse development
use_tidy_description Helpers for tidyverse development
use_tidy_eval Helpers for tidyverse development
use_tidy_github Helpers for tidyverse development
use_tidy_issue_template 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_versions Helpers for tidyverse development
use_travis Continuous integration setup and badges
use_usethis Make usethis available in interactive sessions
use_version Increment package version
use_vignette Create a vignette