Package: usethis 3.1.0
Jennifer Bryan
usethis: Automate Package and Project Setup
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.
Authors:
usethis_3.1.0.tar.gz
usethis_3.1.0.tar.gz(r-4.5-noble)usethis_3.1.0.tar.gz(r-4.4-noble)
usethis_3.1.0.tgz(r-4.4-emscripten)usethis_3.1.0.tgz(r-4.3-emscripten)
usethis.pdf |usethis.html✨
usethis/json (API)
NEWS
| # Install 'usethis' in R: |
| install.packages('usethis', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/r-lib/usethis/issues
Last updated 14 hours agofrom:be1c8decb3. Checks:OK: 2. Indexed: no.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Nov 26 2024 |
| R-4.5-linux | OK | Nov 26 2024 |
Exports:browse_circlecibrowse_cranbrowse_githubbrowse_github_actionsbrowse_github_issuesbrowse_github_pullsbrowse_packagebrowse_projectcreate_download_urlcreate_from_githubcreate_github_tokencreate_packagecreate_projectcreate_tidy_packageedit_fileedit_git_configedit_git_ignoreedit_pkgdown_configedit_r_buildignoreedit_r_environedit_r_makevarsedit_r_profileedit_rstudio_prefsedit_rstudio_snippetsedit_templategh_token_helpgit_branch_defaultgit_default_branchgit_default_branch_configuregit_default_branch_rediscovergit_default_branch_renamegit_protocolgit_remotesgit_sitrepgit_vaccinateissue_close_communityissue_reprex_neededlocal_projectpr_fetchpr_finishpr_forgetpr_initpr_merge_mainpr_pausepr_pullpr_pushpr_resumepr_viewproj_activateproj_getproj_pathproj_setproj_sitreprename_filestidy_label_colourstidy_label_descriptionstidy_labelstidy_labels_renameui_codeui_code_blockui_doneui_fieldui_infoui_lineui_nopeui_oopsui_pathui_silenceui_stopui_todoui_unsetui_valueui_warnui_yeahuse_addinuse_agpl_licenseuse_agpl3_licenseuse_apache_licenseuse_apl2_licenseuse_articleuse_authoruse_badgeuse_binder_badgeuse_bioc_badgeuse_blank_slateuse_build_ignoreuse_cuse_cc0_licenseuse_ccby_licenseuse_circleciuse_circleci_badgeuse_citationuse_code_of_conductuse_conflicteduse_courseuse_coverageuse_covr_ignoreuse_cpp11use_cran_badgeuse_cran_commentsuse_datause_data_rawuse_data_tableuse_descriptionuse_description_defaultsuse_dev_packageuse_dev_versionuse_devtoolsuse_directoryuse_gituse_git_configuse_git_hookuse_git_ignoreuse_git_protocoluse_git_remoteuse_githubuse_github_actionuse_github_action_check_fulluse_github_action_check_releaseuse_github_action_check_standarduse_github_action_pr_commandsuse_github_actionsuse_github_actions_badgeuse_github_fileuse_github_labelsuse_github_linksuse_github_pagesuse_github_releaseuse_gitlab_ciuse_gpl_licenseuse_gpl3_licenseuse_import_fromuse_jenkinsuse_latest_dependenciesuse_lgpl_licenseuse_lifecycleuse_lifecycle_badgeuse_logouse_makeuse_mit_licenseuse_namespaceuse_news_mduse_packageuse_package_docuse_partial_warningsuse_pipeuse_pkgdownuse_pkgdown_github_pagesuse_posit_cloud_badgeuse_proprietary_licenseuse_ruse_rcppuse_rcpp_armadillouse_rcpp_eigenuse_readme_mduse_readme_rmduse_release_issueuse_reprexuse_revdepuse_rmarkdown_templateuse_roxygen_mduse_rscloud_badgeuse_rstudiouse_rstudio_preferencesuse_spell_checkuse_standaloneuse_templateuse_testuse_test_helperuse_testthatuse_tibbleuse_tidy_cocuse_tidy_contributinguse_tidy_dependenciesuse_tidy_descriptionuse_tidy_evaluse_tidy_githubuse_tidy_github_actionsuse_tidy_github_labelsuse_tidy_issue_templateuse_tidy_logouse_tidy_styleuse_tidy_supportuse_tidy_thanksuse_tidy_upkeep_issueuse_tutorialuse_upkeep_issueuse_usethisuse_versionuse_vignetteuse_zipwith_projectwrite_overwrite_union
Dependencies:askpassclicliprcrayoncredentialscurldescfsgertghgitcredsgluehttr2inijsonlitelifecyclemagrittropensslpurrrR6rappdirsrlangrprojrootrstudioapisysvctrswhiskerwithryamlzip
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| README badges | badges use_badge use_binder_badge use_bioc_badge use_cran_badge use_lifecycle_badge use_posit_cloud_badge |
| Visit important project-related web pages | browse-this browse_circleci browse_cran browse_github browse_github_actions browse_github_issues browse_github_pulls browse_package browse_project |
| Create a project from a GitHub repo | create_from_github |
| Create a package or project | create_package create_project |
| Open configuration files | edit edit_git_config edit_git_ignore edit_pkgdown_config edit_rstudio_prefs edit_rstudio_snippets edit_r_buildignore edit_r_environ edit_r_makevars edit_r_profile |
| See or set the default Git protocol | git_protocol use_git_protocol |
| Git/GitHub sitrep | git_sitrep |
| Vaccinate your global gitignore file | git_vaccinate |
| Get or set the default Git branch | git-default-branch git_default_branch git_default_branch_configure git_default_branch_rediscover git_default_branch_rename |
| Get help with GitHub personal access tokens | create_github_token gh_token_help github-token |
| Helpers for GitHub issues | issue-this issue_close_community issue_reprex_needed |
| License a package | use_agpl3_license use_agpl_license use_apache_license use_apl2_license use_cc0_license use_ccby_license use_gpl3_license use_gpl_license use_lgpl_license use_mit_license use_proprietary_license |
| Activate a project | proj_activate |
| Report working directory and usethis/RStudio project | proj_sitrep |
| Utility functions for the active project | local_project proj_get proj_path proj_set proj_utils with_project |
| Helpers for GitHub pull requests | pr_fetch pr_finish pr_forget pr_init pr_merge_main pr_pause pr_pull pr_push pr_resume pr_view pull-requests |
| Automatically rename paired R/ and test/ files | rename_files |
| Helpers to make useful changes to '.Rprofile' | rprofile-helper use_conflicted use_devtools use_partial_warnings use_reprex use_usethis |
| Suppress usethis's messaging | ui_silence |
| Add minimal RStudio Addin binding | use_addin |
| Add an author to the 'Authors@R' field in DESCRIPTION | use_author |
| Don't save/load user workspace between sessions | use_blank_slate |
| Add files to '.Rbuildignore' | use_build_ignore |
| Create a CITATION template | use_citation |
| Add a code of conduct | use_code_of_conduct |
| Test coverage | use_coverage use_covr_ignore |
| Use C++ via the cpp11 package | use_cpp11 |
| CRAN submission comments | use_cran_comments |
| Create package data | use_data use_data_raw |
| Prepare for importing data.table | use_data_table |
| Create or modify a DESCRIPTION file | use_description use_description_defaults |
| Use a directory | use_directory |
| Initialise a git repository | use_git |
| Configure Git | use_git_config |
| Add a git hook | use_git_hook |
| Tell Git to ignore files | use_git_ignore |
| Configure and report Git remotes | git_remotes use_git_remote |
| Connect a local repo with GitHub | use_github |
| Set up a GitHub Actions workflow | use_github_action |
| Copy a file from any GitHub repo into the current project | use_github_file |
| Manage GitHub issue labels | tidy_labels tidy_labels_rename tidy_label_colours tidy_label_descriptions use_github_labels use_tidy_github_labels |
| Use GitHub links in URL and BugReports | use_github_links |
| Configure a GitHub Pages site | use_github_pages |
| Publish a GitHub release | use_github_release |
| Continuous integration setup and badges | use_circleci use_circleci_badge use_gitlab_ci |
| Import a function from another package | use_import_from |
| Create Jenkinsfile for Jenkins CI Pipelines | use_jenkins |
| Use lifecycle badges | use_lifecycle |
| Use a package logo | use_logo |
| Create Makefile | use_make |
| Use a basic 'NAMESPACE' | use_namespace |
| Create a simple 'NEWS.md' | use_news_md |
| Depend on another package | use_dev_package use_package |
| Package-level documentation | use_package_doc |
| Use magrittr's pipe in your package | use_pipe |
| Use pkgdown | use_pkgdown use_pkgdown_github_pages |
| Create or edit R or test files | use_r use_test |
| Use C, C++, RcppArmadillo, or RcppEigen | use_c use_rcpp use_rcpp_armadillo use_rcpp_eigen |
| Create README files | use_readme_md use_readme_rmd |
| Create a release checklist in a GitHub issue | use_release_issue |
| Reverse dependency checks | use_revdep |
| Add an RMarkdown Template | use_rmarkdown_template |
| Use roxygen2 with markdown | use_roxygen_md |
| Add RStudio Project infrastructure | use_rstudio |
| Set global RStudio preferences | use_rstudio_preferences |
| Use spell check | use_spell_check |
| Use a standalone file from another repo | use_standalone |
| Use a usethis-style template | use_template |
| Create or edit a test helper file | use_test_helper |
| Sets up overall testing infrastructure | use_testthat |
| Prepare to return a tibble | use_tibble |
| Helpers for tidyverse development | create_tidy_package tidyverse use_tidy_coc use_tidy_contributing use_tidy_dependencies use_tidy_description use_tidy_github use_tidy_github_actions use_tidy_issue_template use_tidy_logo use_tidy_style use_tidy_support use_tidy_upkeep_issue |
| Identify contributors via GitHub activity | use_tidy_thanks |
| Create a learnr tutorial | use_tutorial |
| Create an upkeep checklist in a GitHub issue | use_upkeep_issue |
| Increment package version | use_dev_version use_version |
| Create a vignette or article | use_article use_vignette |
| Options consulted by usethis | usethis_options |
| Download and unpack a ZIP file | use_course use_zip zip-utils |
