API for usethis
Automate Package and Project Setup
| Global functions | |
|---|---|
| .rlang_as_friendly_type | Source code |
| .rlang_check_is_string | Source code |
| .rlang_stop_unexpected_typeof | Source code |
| .stop_not_number | Source code |
| air_toml_regex | Source code |
| all_configs | Source code |
| as_standalone_dest_file | Source code |
| as_standalone_file | Source code |
| as_test_helper_file | Source code |
| as_timestamp | Source code |
| as_version_info | Source code |
| as_version_info_row | Source code |
| asciify | Source code |
| author_has_rstudio_email | Source code |
| badges | Man page |
| base_and_recommended | Source code |
| block_append | Source code |
| block_create | Source code |
| block_find | Source code |
| block_replace | Source code |
| block_show | Source code |
| branches_with_no_upstream_or_github_upstream | Source code |
| browse-this | Man page |
| browse_circleci | Man page Source code |
| browse_cran | Man page Source code |
| browse_github | Man page Source code |
| browse_github_actions | Man page Source code |
| browse_github_issues | Man page Source code |
| browse_github_pulls | Man page Source code |
| browse_package | Man page Source code |
| browse_project | Man page Source code |
| bulletize | Source code |
| bump_ | Source code |
| bump_version | Source code |
| can_overwrite | Source code |
| cfg_fork | Source code |
| cfg_fork_cannot_push_origin | Source code |
| cfg_fork_upstream_is_not_origin_parent | Source code |
| cfg_maybe_fork | Source code |
| cfg_maybe_ours_or_theirs | Source code |
| cfg_no_github | Source code |
| cfg_ours | Source code |
| cfg_theirs | Source code |
| cfg_upstream_but_origin_is_not_fork | Source code |
| challenge_default_author | Source code |
| challenge_home_directory | Source code |
| challenge_legacy_author_fields | Source code |
| challenge_nested_project | Source code |
| challenge_non_default_branch | Source code |
| challenge_uncommitted_changes | Source code |
| check_arg | Source code |
| check_author_is_novel | Source code |
| check_bool | Source code |
| check_branch_pulled | Source code |
| check_branch_pushed | Source code |
| check_branch_up_to_date | Source code |
| check_call | Source code |
| check_can_push | Source code |
| check_character | Source code |
| check_closure | Source code |
| check_cpp_register_deps | Source code |
| check_current_branch | Source code |
| check_data_frame | Source code |
| check_directory_is_empty | Source code |
| check_edition | Source code |
| check_environment | Source code |
| check_file_name | Source code |
| check_files_absent | Source code |
| check_for_bad_config | Source code |
| check_for_config | Source code |
| check_for_maybe_config | Source code |
| check_formula | Source code |
| check_fun_exists | Source code |
| check_function | Source code |
| check_functions_exist | Source code |
| check_github_has_SHA | Source code |
| check_has_package_doc | Source code |
| check_is_named_list | Source code |
| check_is_package | Source code |
| check_is_project | Source code |
| check_is_zip | Source code |
| check_license_version | Source code |
| check_logical | Source code |
| check_name | Source code |
| check_no_github_repo | Source code |
| check_no_origin | Source code |
| check_number_decimal | Source code |
| check_number_whole | Source code |
| check_package_name | Source code |
| check_path_is_directory | Source code |
| check_pr_branch | Source code |
| check_protocol | Source code |
| check_string | Source code |
| check_symbol | Source code |
| check_uses_git | Source code |
| check_uses_github_actions | Source code |
| check_uses_roxygen | Source code |
| check_vignette_extension | Source code |
| check_vignette_name | Source code |
| checklist_footer | Source code |
| choose_branch | Source code |
| choose_gha_workflow | Source code |
| choose_pr | Source code |
| choose_template | Source code |
| choose_version | Source code |
| circleci_activate | Source code |
| classify_url | Source code |
| code_hint_with_host | Source code |
| compact | Source code |
| compute_active_name | Source code |
| compute_n_show | Source code |
| compute_name | Source code |
| conspicuous_place | Source code |
| content_disposition | Source code |
| content_type | Source code |
| count_directory_files | Source code |
| cran_home | Source code |
| cran_results_url | Source code |
| cran_version | Source code |
| create_air_toml | Source code |
| create_directory | Source code |
| create_download_url | Man page Source code |
| create_from_github | Man page Source code |
| create_gh_pages_branch | Source code |
| create_github_token | Man page Source code |
| create_package | Man page Source code |
| create_project | Man page Source code |
| create_quarto_project | Man page Source code |
| create_tidy_package | Man page Source code |
| create_vscode_directory | Source code |
| create_vscode_json_file | Source code |
| data.frame | Source code |
| default_api_url | Source code |
| default_branch_candidates | Source code |
| default_branch_sitrep | Source code |
| default_cran_mirror | Source code |
| desc_urls | Source code |
| detect_line_ending | Source code |
| directory_has_files | Source code |
| dots | Source code |
| download_url | Source code |
| edit | Man page |
| edit_file | Man page Source code |
| edit_git_config | Man page Source code |
| edit_git_ignore | Man page Source code |
| edit_pkgdown_config | Man page Source code |
| edit_r_buildignore | Man page Source code |
| edit_r_environ | Man page Source code |
| edit_r_makevars | Man page Source code |
| edit_r_profile | Man page Source code |
| edit_rstudio_prefs | Man page Source code |
| edit_rstudio_snippets | Man page Source code |
| edit_template | Man page Source code |
| ensure_core_excludesFile | Source code |
| escape_path | Source code |
| expand_github | Source code |
| find_readme | Source code |
| find_rstudio_root | Source code |
| find_template | Source code |
| fishy_badges | Source code |
| fishy_bookdown_config | Source code |
| fishy_github_actions | Source code |
| format.github_remote_config | Source code |
| gert_shush | Source code |
| get_apiurl | Source code |
| get_baseurl | Source code |
| get_cpp_register_deps | Source code |
| get_hosturl | Source code |
| get_objs_from_dots | Source code |
| get_posit_roles | Source code |
| get_release_data | Source code |
| get_release_news | Source code |
| get_revdeps | Source code |
| get_vignette_extension | Source code |
| gh_milestone_number | Source code |
| gh_token_help | Man page Source code |
| gh_tr | Source code |
| git-default-branch | Man page |
| git_ask_commit | Source code |
| git_branch | Source code |
| git_branch_compare | Source code |
| git_branch_tracking | Source code |
| git_can_push | Source code |
| git_cfg_get | Source code |
| git_clean | Source code |
| git_conflict_report | Source code |
| git_default_branch | Man page Source code |
| git_default_branch_ | Source code |
| git_default_branch_configure | Man page Source code |
| git_default_branch_rediscover | Man page Source code |
| git_default_branch_remote | Source code |
| git_default_branch_rename | Man page Source code |
| git_ignore_path | Source code |
| git_init | Source code |
| git_parse_remref | Source code |
| git_protocol | Man page Source code |
| git_pull | Source code |
| git_push | Source code |
| git_push_first | Source code |
| git_remotes | Man page Source code |
| git_repo | Source code |
| git_sitrep | Man page Source code |
| git_status | Source code |
| git_uncommitted | Source code |
| git_user_check | Source code |
| git_user_get | Source code |
| git_user_sitrep | Source code |
| git_vaccinate | Man page Source code |
| git_vaccinated | Source code |
| github-token | Man page |
| github_remote_config | Source code |
| github_remote_config_wat | Source code |
| github_remote_list | Source code |
| github_remotes | Source code |
| github_url | Source code |
| github_url_from_git_remotes | Source code |
| glue_chr | Source code |
| glue_data_chr | Source code |
| guess_local_default_branch | Source code |
| has_badge | Source code |
| has_citation_file | Source code |
| has_coc | Source code |
| has_github_links | Source code |
| has_old_cran_comments | Source code |
| has_package_doc | Source code |
| hopeless_url | Source code |
| how_to_use | Source code |
| in_rstudio | Source code |
| in_rstudio_server | Source code |
| indent | Source code |
| isFALSE | Source code |
| isNA | Source code |
| is_check_action | Source code |
| is_coverage_action | Source code |
| is_dev_version | Source code |
| is_github_dot_com | Source code |
| is_github_enterprise | Source code |
| is_in_posit_org | Source code |
| is_in_proj | Source code |
| is_installed | Source code |
| is_linux | Source code |
| is_online | Source code |
| is_package | Source code |
| is_posit_cph_or_fnd | Source code |
| is_posit_person_canonical | Source code |
| is_posit_pkg | Source code |
| is_positron | Source code |
| is_quiet | Source code |
| is_rstudio_project | Source code |
| is_shortlink | Source code |
| is_windows | Source code |
| issue-this | Man page |
| issue_close_community | Man page Source code |
| issue_comment_add | Source code |
| issue_details | Source code |
| issue_edit | Source code |
| issue_gh | Source code |
| issue_info | Source code |
| issue_reprex_needed | Man page Source code |
| keep_lgl | Source code |
| kv_line | Source code |
| last_upkeep_date | Source code |
| last_upkeep_year | Source code |
| latest_release | Source code |
| license_abbr | Source code |
| local_project | Man page Source code |
| lowercase_r | Source code |
| make_filename | Source code |
| make_spec | Source code |
| make_upkeep_issue | Source code |
| maybe_name | Source code |
| modify_drive_url | Source code |
| modify_dropbox_url | Source code |
| modify_github_url | Source code |
| modify_rproj | Source code |
| new_fork | Source code |
| new_fork_cannot_push_origin | Source code |
| new_fork_upstream_is_not_origin_parent | Source code |
| new_github_remote_config | Source code |
| new_maybe_fork | Source code |
| new_maybe_ours_or_theirs | Source code |
| new_no_github | Source code |
| new_ours | Source code |
| new_theirs | Source code |
| new_upstream_but_origin_is_not_fork | Source code |
| news_latest | Source code |
| normalize_host | Source code |
| normalize_url | Source code |
| obj_type_friendly | Source code |
| obj_type_oo | Source code |
| oxford_comma | Source code |
| package_doc_path | Source code |
| package_remote | Source code |
| param_repo_spec | Source code |
| parse_content_disposition | Source code |
| parse_file_url | Source code |
| parse_github_remotes | Source code |
| parse_repo_spec | Source code |
| parse_repo_url | Source code |
| parse_rproj | Source code |
| pat_sitrep | Source code |
| path_before_slash | Source code |
| path_first_existing | Source code |
| pick_tag | Source code |
| pkg_minimum_r_version | Source code |
| pkgdown_config | Source code |
| pkgdown_config_meta | Source code |
| pkgdown_config_path | Source code |
| pkgdown_url | Source code |
| pkgdown_version | Source code |
| platform_line_ending | Source code |
| pluck_chr | Source code |
| pluck_int | Source code |
| pluck_lgl | Source code |
| posit_orgs | Source code |
| possibly_in_proj | Source code |
| pr_branch_delete | Source code |
| pr_clean | Source code |
| pr_create | Source code |
| pr_data_tidy | Source code |
| pr_fetch | Man page Source code |
| pr_find | Source code |
| pr_finish | Man page Source code |
| pr_forget | Man page Source code |
| pr_get | Source code |
| pr_init | Man page Source code |
| pr_list | Source code |
| pr_merge_main | Man page Source code |
| pr_pause | Man page Source code |
| pr_pull | Man page Source code |
| pr_pull_source_override | Source code |
| pr_push | Man page Source code |
| pr_resume | Man page Source code |
| pr_url | Source code |
| pr_view | Man page Source code |
| pre_format_fields | Source code |
| pre_format_remote | Source code |
| print.github_remote_config | Source code |
| print.sitrep | Source code |
| progress_fun | Source code |
| proj_activate | Man page Source code |
| proj_active | Source code |
| proj_crit | Source code |
| proj_deps | Source code |
| proj_desc | Source code |
| proj_desc_create | Source code |
| proj_desc_field_update | Source code |
| proj_find | Source code |
| proj_get | Man page Source code |
| proj_get_ | Source code |
| proj_line_ending | Source code |
| proj_path | Man page Source code |
| proj_path_prep | Source code |
| proj_rel_path | Source code |
| proj_set | Man page Source code |
| proj_set_ | Source code |
| proj_sitrep | Man page Source code |
| proj_utils | Man page |
| proj_version | Source code |
| project_name | Source code |
| pull-requests | Man page |
| quote_if_no_color | Source code |
| r_version | Source code |
| random_colour | Source code |
| re_match | Source code |
| read_github_file | Source code |
| read_more | Source code |
| read_more_maybe | Source code |
| read_utf8 | Source code |
| record_upkeep_date | Source code |
| rediscover_default_branch | Source code |
| ref_df | Source code |
| refuse_package | Source code |
| release_bullets | Source code |
| release_checklist | Source code |
| release_extra_bullets | Source code |
| release_revdepcheck | Source code |
| release_type | Source code |
| releases | Source code |
| remref_branch | Source code |
| remref_remote | Source code |
| rename_files | Man page Source code |
| render_template | Source code |
| report_fishy_files | Source code |
| restart_rstudio | Source code |
| roxygen_ns_append | Source code |
| roxygen_ns_show | Source code |
| roxygen_remind | Source code |
| roxygen_update_ns | Source code |
| rprofile-helper | Man page |
| rproj_path | Source code |
| rproj_paths | Source code |
| rstudio_available | Source code |
| rstudio_config_path | Source code |
| rstudio_git_tickle | Source code |
| rstudio_prefs_read | Source code |
| rstudio_prefs_write | Source code |
| safe_pkg_env | Source code |
| same_contents | Source code |
| scold_for_renviron | Source code |
| scold_for_scopes | Source code |
| scoped_path_r | Source code |
| serialize_rproj | Source code |
| show_includes | Source code |
| single_quote_if_no_color | Source code |
| spec_owner | Source code |
| spec_repo | Source code |
| standalone_choose | Source code |
| standalone_dependencies | Source code |
| standalone_header | Source code |
| stop_bad_github_remote_config | Source code |
| stop_input_type | Source code |
| stop_maybe_github_remote_config | Source code |
| suggests_usage_hint | Source code |
| target_repo | Source code |
| target_repo_spec | Source code |
| testthat_version | Source code |
| tidy-deprecated | Man page |
| tidy_desc | Source code |
| tidy_download | Man page Source code |
| tidy_label_colours | Man page Source code |
| tidy_label_descriptions | Man page Source code |
| tidy_labels | Man page Source code |
| tidy_labels_rename | Man page Source code |
| tidy_minimum_r_version | Source code |
| tidy_unzip | Man page Source code |
| tidy_upkeep_checklist | Source code |
| tidyverse | Man page |
| tidyverse_url | Source code |
| todo | Source code |
| try_download | Source code |
| ui-legacy-functions | Man page |
| ui-questions | Man page |
| ui_abort | Source code |
| ui_bullets | Source code |
| ui_code | Man page Source code |
| ui_code_block | Man page Source code |
| ui_code_snippet | Source code |
| ui_done | Man page Source code |
| ui_field | Man page Source code |
| ui_github_remote_config_wat | Source code |
| ui_info | Man page Source code |
| ui_inform | Source code |
| ui_legacy_bullet | Source code |
| ui_line | Man page Source code |
| ui_nah | Source code |
| ui_nope | Man page Source code |
| ui_oops | Man page Source code |
| ui_path | Man page Source code |
| ui_path_impl | Source code |
| ui_pre_glue | Source code |
| ui_silence | Man page Source code |
| ui_special | Source code |
| ui_stop | Man page Source code |
| ui_todo | Man page Source code |
| ui_unset | Man page Source code |
| ui_value | Man page Source code |
| ui_warn | Man page Source code |
| ui_yeah | Man page Source code |
| ui_yep | Source code |
| update_versions | Source code |
| upkeep_checklist | Source code |
| upkeep_extra_bullets | Source code |
| use_addin | Man page Source code |
| use_agpl3_license | Man page Source code |
| use_agpl_license | Man page Source code |
| use_air | Man page Source code |
| use_apache_license | Man page Source code |
| use_apl2_license | Man page Source code |
| use_article | Man page Source code |
| use_author | Man page Source code |
| use_badge | Man page Source code |
| use_binder_badge | Man page Source code |
| use_bioc_badge | Man page Source code |
| use_blank_slate | Man page Source code |
| use_build_ignore | Man page Source code |
| use_c | Man page Source code |
| use_c_version | Source code |
| use_cc0_license | Man page Source code |
| use_ccby_license | Man page Source code |
| use_circleci | Man page Source code |
| use_circleci_badge | Man page Source code |
| use_citation | Man page Source code |
| use_coc | Source code |
| use_code_of_conduct | Man page Source code |
| use_codecov_badge | Source code |
| use_conflicted | Man page Source code |
| use_course | Man page Source code |
| use_course_details | Man page |
| use_coverage | Man page Source code |
| use_coveralls_badge | Source code |
| use_covr_ignore | Man page Source code |
| use_cpp11 | Man page Source code |
| use_cran_badge | Man page Source code |
| use_cran_comments | Man page Source code |
| use_data | Man page Source code |
| use_data_raw | Man page Source code |
| use_data_table | Man page Source code |
| use_dependency | Source code |
| use_description | Man page Source code |
| use_description_defaults | Man page Source code |
| use_dev_package | Man page Source code |
| use_dev_version | Man page Source code |
| use_devtools | Man page Source code |
| use_directory | Man page Source code |
| use_dot_github | Source code |
| use_git | Man page Source code |
| use_git_config | Man page Source code |
| use_git_hook | Man page Source code |
| use_git_ignore | Man page Source code |
| use_git_protocol | Man page Source code |
| use_git_remote | Man page Source code |
| use_github | Man page Source code |
| use_github_action | Man page Source code |
| use_github_actions_badge | Man page Source code |
| use_github_file | Man page Source code |
| use_github_labels | Man page Source code |
| use_github_links | Man page Source code |
| use_github_pages | Man page Source code |
| use_github_release | Man page Source code |
| use_gitlab_ci | Man page Source code |
| use_gpl3_license | Man page Source code |
| use_gpl_license | Man page Source code |
| use_import_from | Man page Source code |
| use_jenkins | Man page Source code |
| use_latest_dependencies | Man page Source code |
| use_lgpl_license | Man page Source code |
| use_license_template | Source code |
| use_lifecycle | Man page Source code |
| use_lifecycle_badge | Man page Source code |
| use_logo | Man page Source code |
| use_make | Man page Source code |
| use_makevars | Source code |
| use_mit_license | Man page Source code |
| use_namespace | Man page Source code |
| use_news_heading | Source code |
| use_news_md | Man page Source code |
| use_package | Man page Source code |
| use_package_doc | Man page Source code |
| use_partial_warnings | Man page Source code |
| use_pipe | Man page Source code |
| use_pkgdown | Man page Source code |
| use_pkgdown_github_pages | Man page Source code |
| use_pkgdown_url | Source code |
| use_posit_cloud_badge | Man page Source code |
| use_proprietary_license | Man page Source code |
| use_r | Man page Source code |
| use_r_universe_badge | Man page Source code |
| use_rcpp | Man page Source code |
| use_rcpp_armadillo | Man page Source code |
| use_rcpp_eigen | Man page Source code |
| use_readme_md | Man page Source code |
| use_readme_rmd | Man page Source code |
| use_release_issue | Man page Source code |
| use_remote | Source code |
| use_reprex | Man page Source code |
| use_revdep | Man page Source code |
| use_rmarkdown_template | Man page Source code |
| use_roxygen_md | Man page Source code |
| use_rprofile_package | Source code |
| use_rstudio | Man page Source code |
| use_rstudio_preferences | Man page Source code |
| use_spell_check | Man page Source code |
| use_src | Source code |
| use_standalone | Man page Source code |
| use_template | Man page Source code |
| use_test | Man page Source code |
| use_test_helper | Man page Source code |
| use_testthat | Man page Source code |
| use_testthat_impl | Source code |
| use_tibble | Man page Source code |
| use_tidy_coc | Man page Source code |
| use_tidy_contributing | Man page Source code |
| use_tidy_dependencies | Man page Source code |
| use_tidy_description | Man page Source code |
| use_tidy_github | Man page Source code |
| use_tidy_github_actions | Man page Source code |
| use_tidy_github_labels | Man page Source code |
| use_tidy_issue_template | Man page Source code |
| use_tidy_logo | Man page Source code |
| use_tidy_style | Man page Source code |
| use_tidy_support | Man page Source code |
| use_tidy_thanks | Man page Source code |
| use_tidy_upkeep_issue | Man page Source code |
| use_tutorial | Man page Source code |
| use_upkeep_issue | Man page Source code |
| use_usethis | Man page Source code |
| use_version | Man page Source code |
| use_vignette | Man page Source code |
| use_vignette_template | Source code |
| use_vscode_debug | Source code |
| use_zip | Man page Source code |
| user_path_prep | Source code |
| uses_air | Source code |
| uses_git | Source code |
| uses_github_actions | Source code |
| uses_old_testthat_edition | Source code |
| uses_pkgdown | Source code |
| uses_pkgdown_bootstrap_version | Source code |
| uses_roxygen | Source code |
| uses_roxygen_md | Source code |
| uses_testthat | Source code |
| usethis | Man page |
| usethis-package | Man page |
| usethis_description_defaults | Source code |
| usethis_map_cli | Source code |
| usethis_map_cli.NULL | Source code |
| usethis_map_cli.character | Source code |
| usethis_map_cli.default | Source code |
| usethis_options | Man page |
| usethis_theme | Source code |
| usethis_version | Source code |
| valid_file_name | Source code |
| valid_package_name | Source code |
| valid_vignette_name | Source code |
| vec_type_friendly | Source code |
| version_info_df | Source code |
| version_spec | Source code |
| view_url | Source code |
| where_from_scope | Source code |
| with_project | Man page Source code |
| write-this | Man page |
| write_air_vscode_extensions_json | Source code |
| write_air_vscode_settings_json | Source code |
| write_over | Man page Source code |
| write_union | Man page Source code |
| write_utf8 | Source code |
| write_vscode_json | Source code |
| year | Source code |
| zip-utils | Man page |
