usethis (development version)
-use_github()now knows that you can reuse the name of an earlier repo that has since been renamed (@ateucher, #1893).
+The README templates now recommend pak instead of devtools for package installation (@olivroy, #1723).
+use_github()now knows that you can reuse the name of an earlier repo that has since been renamed (@ateucher, #1893).use_git()no longer asks if you want to restart RStudio when using Positron.use_test()anduse_r()now work when you are intests/testthat/_snaps/{foo}.md(@olivroy, #1988).The URLs baked into the badge generated by
use_coverage(type = "codecov")no longer specify a branch (#2008).
diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml
index 23ba741aa..5c9c1d8d2 100644
--- a/dev/pkgdown.yml
+++ b/dev/pkgdown.yml
@@ -7,7 +7,7 @@ articles:
articles/pr-functions: pr-functions.html
articles/ui-cli-conversion: ui-cli-conversion.html
articles/usethis-setup: usethis-setup.html
-last_built: 2024-07-23T19:33Z
+last_built: 2024-07-23T21:15Z
urls:
reference: https://usethis.r-lib.org/reference
article: https://usethis.r-lib.org/articles
diff --git a/dev/search.json b/dev/search.json
index d15aff213..d861c14b7 100644
--- a/dev/search.json
+++ b/dev/search.json
@@ -1 +1 @@
-[{"path":[]},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to usethis","title":"Contributing to usethis","text":"outlines propose change usethis. detailed info contributing , tidyverse packages, please see development contributing guide.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to usethis","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to usethis","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to usethis","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"r-lib/usethis\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to usethis","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to usethis","text":"Please note usethis project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://usethis.r-lib.org/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2020 usethis authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with usethis","title":"Getting help with usethis","text":"Thanks using usethis! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with usethis","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty incredible ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with usethis","text":"Armed reprex, next step figure ask. ’s question: start community.rstudio.com, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with usethis","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"markdown-image-link","dir":"Articles","previous_headings":"","what":"Markdown image link","title":"Exploring badge accessibility","text":"usethis currently inserts badges special “badge block” README, fenced HTML comment tags. Within badge block, badge hyperlinked image, alt text. basic form: Note alt_text static label explaining badge’s purpose, whereas dynamic information baked externally-served image. usethis definitely controls alt_text, something ’d like feedback .","code":"[](http://path/to/more/details)"},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"badge-image","dir":"Articles","previous_headings":"","what":"Badge image","title":"Exploring badge accessibility","text":"badges days tend SVG files, fortunate, since SVGs can carry attributes support accessibility. demonstrate custom badge generated via shields.io web service. request badge URL: badge, hyperlink set https://shields.io/. badge inside HTML comment block, like usethis README badges. ’ve prefixed every field can influence “”; 3 fields: alt text. label. static text appears left side badge, grey background, describes badge. message. text appears right side badge, colored background. often dynamic part, color text convey dynamic fact, e.g. “passing” green background “failing” red background. Now inspect badge SVG. apologize advance amount data displayed , seems good show one badge full gory detail. Later, display badge information selectively. understanding two main pieces metadata title aria-label attribute. reveal just two items badge: badge carries information title aria-label, “my_label: my_message”. interested learn information included twice good bad thing screen reader experience.","code":"https://img.shields.io/badge/my__label-my__message-orange library(xml2) library(purrr) inspect_badge <- function(badge) { badge %>% read_xml() %>% as_list() %>% pluck(\"svg\") } inspect_badge(\"https://img.shields.io/badge/my__label-my__message-orange\") #> $title #> $title[[1]] #> [1] \"my_label: my_message\" #> #> #> $linearGradient #> $linearGradient$stop #> list() #> attr(,\"offset\") #> [1] \"0\" #> attr(,\"stop-color\") #> [1] \"#bbb\" #> attr(,\"stop-opacity\") #> [1] \".1\" #> #> $linearGradient$stop #> list() #> attr(,\"offset\") #> [1] \"1\" #> attr(,\"stop-opacity\") #> [1] \".1\" #> #> attr(,\"id\") #> [1] \"s\" #> attr(,\"x2\") #> [1] \"0\" #> attr(,\"y2\") #> [1] \"100%\" #> #> $clipPath #> $clipPath$rect #> list() #> attr(,\"width\") #> [1] \"144\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"rx\") #> [1] \"3\" #> attr(,\"fill\") #> [1] \"#fff\" #> #> attr(,\"id\") #> [1] \"r\" #> #> $g #> $g$rect #> list() #> attr(,\"width\") #> [1] \"61\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"fill\") #> [1] \"#555\" #> #> $g$rect #> list() #> attr(,\"x\") #> [1] \"61\" #> attr(,\"width\") #> [1] \"83\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"fill\") #> [1] \"#fe7d37\" #> #> $g$rect #> list() #> attr(,\"width\") #> [1] \"144\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"fill\") #> [1] \"url(#s)\" #> #> attr(,\"clip-path\") #> [1] \"url(#r)\" #> #> $g #> $g$text #> $g$text[[1]] #> [1] \"my_label\" #> #> attr(,\"aria-hidden\") #> [1] \"true\" #> attr(,\"x\") #> [1] \"315\" #> attr(,\"y\") #> [1] \"150\" #> attr(,\"fill\") #> [1] \"#010101\" #> attr(,\"fill-opacity\") #> [1] \".3\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"textLength\") #> [1] \"510\" #> #> $g$text #> $g$text[[1]] #> [1] \"my_label\" #> #> attr(,\"x\") #> [1] \"315\" #> attr(,\"y\") #> [1] \"140\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"fill\") #> [1] \"#fff\" #> attr(,\"textLength\") #> [1] \"510\" #> #> $g$text #> $g$text[[1]] #> [1] \"my_message\" #> #> attr(,\"aria-hidden\") #> [1] \"true\" #> attr(,\"x\") #> [1] \"1015\" #> attr(,\"y\") #> [1] \"150\" #> attr(,\"fill\") #> [1] \"#010101\" #> attr(,\"fill-opacity\") #> [1] \".3\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"textLength\") #> [1] \"730\" #> #> $g$text #> $g$text[[1]] #> [1] \"my_message\" #> #> attr(,\"x\") #> [1] \"1015\" #> attr(,\"y\") #> [1] \"140\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"fill\") #> [1] \"#fff\" #> attr(,\"textLength\") #> [1] \"730\" #> #> attr(,\"fill\") #> [1] \"#fff\" #> attr(,\"text-anchor\") #> [1] \"middle\" #> attr(,\"font-family\") #> [1] \"Verdana,Geneva,DejaVu Sans,sans-serif\" #> attr(,\"text-rendering\") #> [1] \"geometricPrecision\" #> attr(,\"font-size\") #> [1] \"110\" #> #> attr(,\"width\") #> [1] \"144\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"role\") #> [1] \"img\" #> attr(,\"aria-label\") #> [1] \"my_label: my_message\" #> attr(,\"xmlns\") #> [1] \"http://www.w3.org/2000/svg\" #> attr(,\"xmlns:xlink\") #> [1] \"http://www.w3.org/1999/xlink\" inspect_badge <- function(badge) { x <- badge %>% read_xml() %>% as_list() %>% pluck(\"svg\") list( title = pluck(x, \"title\", 1), `aria-label` = pluck(x, attr_getter(\"aria-label\")) ) } inspect_badge(\"https://img.shields.io/badge/my__label-my__message-orange\") #> $title #> [1] \"my_label: my_message\" #> #> $`aria-label` #> [1] \"my_label: my_message\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"shields-io-badges-are-accessible-today","dir":"Articles","previous_headings":"Badge image","what":"shields.io badges are accessible today","title":"Exploring badge accessibility","text":"One reasons inspected shields.io badge may provide usable alternative service whose official badge (yet?) screen-reader-friendly. custom badge completely static. shields.io also supports custom dynamic badges, necessary information (label, message, color) available suitable JSON endpoint. Finally, relevant usethis, shields.io offers pre-configured dynamic badges commonly “badged” services, including GitHub Actions Codecov. shields.io badge usethis’s R CMD check workflow GitHub Actions: , indicating fields control my_alt_text my_label, ’s easier get feedback usethis . title aria-label badge : Now take inventory main badges inserted usethis things stand re: accessibility.","code":"inspect_badge(\"https://img.shields.io/github/workflow/status/r-lib/usethis/R-CMD-check?label=my_label-R-CMD-check\") #> $title #> [1] \"my_label-R-CMD-check: https://github.com/badges/shields/issues/8671\" #> #> $`aria-label` #> [1] \"my_label-R-CMD-check: https://github.com/badges/shields/issues/8671\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"r-cmd-check-status","dir":"Articles","previous_headings":"","what":"R CMD check status","title":"Exploring badge accessibility","text":"generally obtain current R CMD check status GitHub Actions workflow. official badge provided GitHub: title aria-label badge : time writing (late December 2021), badge include information. requested GitHub’s Actions Packages Feedback forum response GitHub encouraging. Hopefully native badge gain improved accessibility early 2022. https://github.com/github/feedback/discussions/8974 meantime, one use shields.io badge report R CMD check status, demonstrated previous section. maintainer one-, GitHub badge upgrade slow coming, implement usethis::use_github_actions_badge().","code":"inspect_badge(\"https://github.com/r-lib/usethis/actions/workflows/R-CMD-check.yaml/badge.svg\") #> $title #> [1] \"R-CMD-check - passing\" #> #> $`aria-label` #> NULL"},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"package-lifecycle","dir":"Articles","previous_headings":"","what":"Package lifecycle","title":"Exploring badge accessibility","text":"usethis::use_lifecycle_badge() declares developmental stage package, using framework https://lifecycle.r-lib.org/articles/stages.html. function already inserts shields.io badge: title aria-label badge : ’s possible usethis using badge “owned” lifecycle package. think don’t now, declaring lifecycle stage whole package necessarily imply need take formal dependency lifecycle package, usually causes badges copied man/figures/ directory. Also, badges shipped lifecycle package currently accessible, another reason use . opened issue (https://github.com/r-lib/lifecycle/issues/117). relatively easy fix, since static badges. done, package maintainers need update SVGs stored man/figures/.","code":"inspect_badge(\"https://img.shields.io/badge/lifecycle-stable-brightgreen.svg\") #> $title #> [1] \"lifecycle: stable\" #> #> $`aria-label` #> [1] \"lifecycle: stable\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"cran-status","dir":"Articles","previous_headings":"","what":"CRAN status","title":"Exploring badge accessibility","text":"usethis::use_cran_badge() places badge indicates package version available CRAN. badge served METACRAN (https://www.r-pkg.org) maintainer Gábor Csárdi already incorporated aria-label badges (commit). available badges listed . ’s badge placed usethis::use_cran_badge(): title aria-label badge : time writing (late December 2021), aria-label present, title . interested know good situation using screen reader.","code":"inspect_badge(\"https://www.r-pkg.org/badges/version/usethis\") #> $title #> NULL #> #> $`aria-label` #> [1] \"CRAN 2.2.3\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"code-coverage","dir":"Articles","previous_headings":"","what":"Code coverage","title":"Exploring badge accessibility","text":"usethis::use_coverage(type = c(\"codecov\", \"coveralls\", ...) calls internal helper usethis:::use_codecov_badge() insert badge either Codecov Coveralls service. examples two badges (note usethis use Coveralls, ’m using different package demo): title aria-label badges:: time writing (late December 2021), neither badge offers title aria-label. badges shields.io Codecov Coveralls: title aria-label shields.io badges::","code":"inspect_badge(\"https://codecov.io/gh/r-lib/usethis/branch/main/graph/badge.svg\") #> $title #> NULL #> #> $`aria-label` #> NULL inspect_badge(\"https://coveralls.io/repos/github/trinker/sentimentr/badge.svg?branch=master\") #> $title #> NULL #> #> $`aria-label` #> NULL inspect_badge(\"https://img.shields.io/codecov/c/github/r-lib/usethis?label=test%20coverage&logo=codecov\") #> $title #> [1] \"test coverage: 59%\" #> #> $`aria-label` #> [1] \"test coverage: 59%\" inspect_badge(\"https://img.shields.io/coveralls/github/trinker/sentimentr?logo=coveralls\") #> $title #> [1] \"coverage: 19%\" #> #> $`aria-label` #> [1] \"coverage: 19%\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"bioconductor","dir":"Articles","previous_headings":"","what":"Bioconductor","title":"Exploring badge accessibility","text":"package Bioconductor, usethis::use_bioc_badge() can used insert badge Bioconductor build status. badge: title aria-label badge: time writing (late December 2021), badge title aria-label. ’s immediately clear resolve , suspect Bioconductor receptive request create accessible badges.","code":"inspect_badge(\"http://www.bioconductor.org/shields/build/release/bioc/biocthis.svg\") #> $title #> NULL #> #> $`aria-label` #> NULL"},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"tldr-use-https-2fa-and-a-github-personal-access-token","dir":"Articles","previous_headings":"","what":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","title":"Managing Git(Hub) Credentials","text":"main recommendations : Adopt HTTPS Git transport protocol. Turn two-factor authentication GitHub account. Use personal access token (PAT) Git remote operations command line R. Allow tools store retrieve credentials Git credential store. previously set GitHub PAT .Renviron, stop . Next provide context rationale recommendations. following section, explain actually implement .","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"https-vs-ssh","dir":"Articles","previous_headings":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","what":"HTTPS vs SSH","title":"Managing Git(Hub) Credentials","text":"Instead HTTPS, use SSH. Many people valid reasons preferring SSH carry . recommendation HTTPS ’s easier SSH newcomers set correctly, especially Windows. GitHub also long recommended HTTPS new users. Finally, using HTTPS PAT kills two birds one stone: single credential can used authenticate GitHub regular Git server REST API. authenticate via SSH “regular” Git work, still set PAT work uses REST API.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"two-factor-authentication","dir":"Articles","previous_headings":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","what":"Two-factor authentication","title":"Managing Git(Hub) Credentials","text":"Turning two-factor authentication important online accounts just good idea, general. example, make 2FA hard requirement members tidyverse r-lib GitHub organizations. past, activating 2FA also forced using HTTPS use PAT, instead “username + password”, operations like git push. Using PAT now absolute requirement, operations using HTTPS protocol, longer anything 2FA. background deprecation “username + password” can found GitHub’s blog post Token authentication requirements Git operations.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"git-credential-helpers-and-the-credential-store","dir":"Articles","previous_headings":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","what":"Git credential helpers and the credential store","title":"Managing Git(Hub) Credentials","text":"’s awkward provide credentials every single Git transaction, ’s customary let system remember credentials. Git uses -called credential helpers , happily, tend “just work” days (especially, macOS Windows) 1. Git credential helpers take advantage official OS-provided credential stores, possible, macOS Keychain Windows Credential Manager. Recent innovations gert gh mean Git/GitHub operations R can also store discover credentials using official Git credential helpers. means can stop storing GitHub PATs plain text startup file, like .Renviron 2. , turn, reduces risk accidentally leaking credentials.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"practical-instructions","dir":"Articles","previous_headings":"","what":"Practical instructions","title":"Managing Git(Hub) Credentials","text":"actually implement recommendations? diagnostic functions usethis::gh_token_help() usethis::git_sitrep() offer advice see , directly R session.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"adopt-https","dir":"Articles","previous_headings":"Practical instructions","what":"Adopt HTTPS","title":"Managing Git(Hub) Credentials","text":"Make sure use HTTPS URLs, SSH, cloning repos adding new remotes: HTTPS URLs look like : https://github.com/
![](\"man/figures/logo.png\"){kind=logo}
. gives nicer display retina displays. logo also linked pkgdown site available (#536). creating new package, use create_tidy_package() start package following tidyverse standards (#461). NEWS.md development version use “(development version)” rather specific version (#440). pkgdown sites now built travis deployed automatically GitHub pages. use_pkgdown_travis() help set . starting release process, call use_release_issue() create release checklist issue (#338). Prior CRAN submission call use_tidy_release_test_env() update test environment section cran-comments() (#496). acceptance, try use_github_release() automatically create release. ’s created draft chance look publishing. use_vignette() includes standard initialisation chunk knitr::opts_chunk$set(comment = \"#>\", collapse = TRUE) used Rmds.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-not-already-mentioned-1-5-0","dir":"Changelog","previous_headings":"","what":"New functions not already mentioned","title":"usethis 1.5.0","text":"use_devtools() (#624), use_conflicted() (#362), use_reprex() (#465) help add useful packages .Rprofile. use_partial_warnings() helps user add standard warning block .Rprofile (#64). edit_r_buildignore() opens .Rbuildignore manual editing (#462, @bfgray3). use_lgpl_license() automates set LGL license (#448, @krlmlr). use_ccby_license() adds CCBY 4.0 license (#547, @njtierney). use_rcpp_armadillo() use_rcpp_eigen() set package use RcppArmadillo RcppEigen, respectively (#421, @coatless, @duckmayr). use_c(\"foo\") sets src/ creates src/foo.c (#117). use_covr_ignore() makes easy ignore files test coverage (#434). use_pkgdown_travis() helps set pkgdown automatic build--deploy Travis-CI GitHub Pages (#524). use_addin() setup RStudio addins (#353, @haozhu233). use_tutorial() creates new interactive R Markdown tutorial, implemented learnr package (@angela-li, #645). use_article() creates articles, vignettes automatically added .Rbuildignore. appear pkgdown sites, included package (#281). use_citation() creates basic CITATION template puts right place (#100).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"other-minor-bug-fixes-and-improvements-1-5-0","dir":"Changelog","previous_headings":"","what":"Other minor bug fixes and improvements","title":"usethis 1.5.0","text":"write_union() appends novel lines, remove duplicates existing lines (#583, @khailper). use_rcpp(\"foo\") now creates src/foo.cpp (#117). use_data() gains version argument defaults serialization format version 2 (#675). use_data_raw() accepts name --prepared dataset opens templated R script (#646). browse_github() now falls back CRAN organisation (warning) package doesn’t GitHub repo (#186). create_*() restore active project error part way , use proj_activate() (#453, #511). edit_r_profile() edit_r_environ() now respect environment variables R_PROFILE_USER R_ENVIRON_USER, respectively (#480). use_description() prints generated description (#287). use_description_field() longer sensitive whitespace, allows use_vignette() work even VignetteBuilder field spread multiple lines (#439). use_logo() can override existing logo user gives permission (#454). also produces retina appropriate logos default, matches aspect ratio http://hexb./sticker.html specification (#499). use_news_md() optionally commit. use_package() gains min_version argument specify minimum version requirement (#498). Set TRUE use currently installed version (#386). used use_tidy_eval() order require version 0.1.2 greater rlang (#484). use_pkgdown() now configurable site options (@jayhesselberth, #467), longer creates docs/ directory (#495). use_test() longer forces filename lowercase (#613, @stufield). use_test() include context() generated file used testthat 2.1.0 (future release testthat) (#325). use_tidy_description() sets Encoding field DESCRIPTION (#502, @krlmlr). use_tidy_eval() re-exports := (#595, @jonthegeek). use_tidy_versions() source argument can choose use local CRAN versions (#309). use_travis() gains ext argument, defaulting \"org\". Use ext = \"com\" https://travis-ci.com (@cderv, #500). use_version() asks committing. use_vignette() now title argument used YAML header (two places needed). vignettes also lose default author date fields (@rorynolan, #445), R Markdown starter material. gain standard setup chunk. use_version(\"dev\") now creates standard “(development version)” heading NEWS.md (#440). use_vignette() now checks vignette name valid (starts letter consists letters, numbers, hyphen, underscore) throws error (@akgold, #555). restart_rstudio() now returns FALSE RStudio project open, fixing issue caused errors helpers suggest restarting RStudio (@gadenbuie, #571).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"dependency-changes-1-5-0","dir":"Changelog","previous_headings":"","what":"Dependency changes","title":"usethis 1.5.0","text":"withr moves Suggests Imports. purrr yaml new Imports.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-140","dir":"Changelog","previous_headings":"","what":"usethis 1.4.0","title":"usethis 1.4.0","text":"CRAN release: 2018-08-14","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"file-system-1-4-0","dir":"Changelog","previous_headings":"","what":"File system","title":"usethis 1.4.0","text":"usethis file system operations now use fs package (#177). change usethis functions, users may notice features fs-mediated paths: Paths “tidy”, meaning / path separator never multiple trailing /. Paths UTF-8 encoded. Windows user’s home directory interpreted C:\\Users\\username (typical Unix-oriented tools, like Git ssh; also matches Python), opposed C:\\Users\\username\\Documents (R’s default Windows). Read fs::path_expand().","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"extending-or-wrapping-usethis-1-4-0","dir":"Changelog","previous_headings":"","what":"Extending or wrapping usethis","title":"usethis 1.4.0","text":"changes make easier others extend usethis, .e. create workflow packages specific organization, use usethis packages. proj_path() newly exported. Use build paths within active project. Like proj_get() proj_set(), aimed end users, rather use extension packages. End users use rprojroot simpler companion, , programmatically detect project build paths within (#415, #425). edit_file(), write_over(), write_union() newly exported helpers. mostly internal use, can also useful packages extend customize usethis (#344, #366, #389). use_template() longer errors user chooses overwrite existing file simply exits confirmation file unchanged (#348, #350, @boshek). getOption(\"usethis.quiet\", default = FALSE) consulted printing user-facing messages. Set option TRUE suppress output, e.g., use usethis functions quietly another package. example, use withr::local_options(list(usethis.quiet = TRUE)) calling function (#416, #424).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-4-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.4.0","text":"proj_sitrep() reports current working directory, active usethis project, active RStudio Project. Call function things seem weird ’re sure ’s wrong fix . Designed interactive use debugging, programmatic use (#426). use_tibble() minimum setup necessary package returns exports tibble. example, guarantees tibble print tibble (#324 @martinjhnhadley). use_logo() resizes adds logo package (#358, @jimhester). use_spell_check() adds whitelist words unit test spell check package documentation R CMD check (#285 @jeroen).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"other-small-changes-and-bug-fixes-1-4-0","dir":"Changelog","previous_headings":"","what":"Other small changes and bug fixes","title":"usethis 1.4.0","text":"usethis new logo! (#429) use_course() reports progress download (#276, #380). use_git() makes initial commit files user gives explicit consent (#378). create_from_github(): repo argument renamed repo_spec, since takes input form “OWNER/REPO” (#376). use_depsy_badge() defunct. Depsy project officially concluded longer maintained (#354). use_github() fails earlier, informative message, absence GitHub personal access token (PAT). Also looks PAT proactively usual environment variables (.e., GITHUB_PAT, GITHUB_TOKEN) (#320, #340, @cderv). logic setting DESCRIPTION fields create_package() use_description() got Spring Cleaning. Fields directly specified user take precedence, named list getOption(\"usethis.description\") consulted, finally defaults built usethis. use_description_defaults() new function reveals fields found options built usethis. Options specific one DESCRIPTION field, e.g. devtools.desc.license, longer supported. Instead, use single named list fields, preferably stored option named \"usethis.description\" (however,\"devtools.desc\" still consulted backwards compatibility). (#159, #233, #367)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"dependency-changes-1-4-0","dir":"Changelog","previous_headings":"","what":"Dependency changes","title":"usethis 1.4.0","text":"New Imports: fs, glue, utils longer Imports: backports, httr, rematch2, rmarkdown (moved Suggests), styler (moved Suggests)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-130","dir":"Changelog","previous_headings":"","what":"usethis 1.3.0","title":"usethis 1.3.0","text":"CRAN release: 2018-02-24 usethis website: https://usethis.r-lib.org (#217). includes article advice system setup, usethis R development generally. edit_*() functions now return target path, invisibly (#255). edit_git_ignore(scope = \"user\") prefers ~/.gitignore, detects existing ~/.gitignore_global, exists. new global gitignore file created, created ~/.gitignore recorded user’s git config core.excludesfile (#255). create_from_github() gains several arguments new functionality. protocol argument lets user convey whether remote URLs ssh https. case “fork clone”, original repo added upstream remote. now possible – although rarely necessary – directly specify GitHub PAT, credentials (git2r form), GitHub host (#214, #214, #253). use_github_labels() can create update colour arbitrary GitHub issue labels, defaulting set labels colours used tidyverse packages, now exposed via tidy_labels(). set now includes labels “good first issue” “help wanted” (#168, #249). appveyor_info() longer reverses repo’s URL image link. Corrects markdown produced use_appveyor_badge() (#240, @llrs). use_cran_badge() uses HTTPS URL CRAN badge image (#235, @jdblischak). create_package() create_project() return normalized path, even target directory pre-exist (#227, #228).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-3-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.3.0","text":"use_git_config() can set user’s Git name email, globally locally project/repo (#267). browse_github_pat() goes webpage GitHub user can create personal access token (PAT) GitHub API. user configures PAT, can use functions like create_from_github() use_github() easily create connect GitHub repos local projects. (#248, #257, @jeroen, via @jennybc). use_version() increments version active package, including interactive chooser. use_dev_version() now special case wrapper around . (#188, #223, @EmilHvitfeldt). use_tidy_github() creates standard set files make GitHub repository navigable users contributors: issue template, contributing guidelines, support documentation, code conduct. now placed .github/ subdirectory (#165, @batpigandme). use_bioc_badge creates Bioconductor badge links build report (#271, @LiNk-NY). use_binder_badge() creates badge indicating repository can launched executable environment via Binder (#242, @uribo).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-120","dir":"Changelog","previous_headings":"","what":"usethis 1.2.0","title":"usethis 1.2.0","text":"CRAN release: 2018-01-19","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-2-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.2.0","text":"use_course() downloads folder’s worth materials ZIP file, deliberate choices around default folder name location. Developed use start workshop. Helps participants obtain materials , e.g., DropBox folder GitHub repo (#196). use_blank_slate() provides way opt RStudio workflow user’s workspace neither saved reloaded R sessions. Automated scope = \"project\". Provides UI instructions scope = \"user\", now (#139). use_tidy_style() styles entire project according https://style.tidyverse.org (#72, #197 @lorenzwalthert). GitHub conventions common tidyverse packages enacted use_tidy_contributing(), use_tidy_issue_template(), use_tidy_support() (@batpigandme, #143, #166). changes New projects don’t exhibit obvious criteria “project” include sentinel, empty file named ., can recognized project. Project launching switching works RStudio server (#115, #129). use_template() newly exported, packages can provide templating functions using framework (@ijlyttle #120). use_readme_rmd() use_readme_md() work, similar fashion, projects package (#131, #135). use_readme_rmd() creates pre-commit git hook, help keep README.Rmd README.md sync (@PeteHaitch #41). Substantial increase unit test coverage.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-110","dir":"Changelog","previous_headings":"","what":"usethis 1.1.0","title":"usethis 1.1.0","text":"CRAN release: 2017-11-17","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-helpers-1-1-0","dir":"Changelog","previous_headings":"","what":"New helpers","title":"usethis 1.1.0","text":"browse_github(), browse_github_issues(), browse_github_pulls(), browse_cran() browse_travis() open useful websites related current project named package. (#96, #103). create_from_github() creates project existing GitHub repository, forking needed (#109). use_cc0_license() applies CC0 license, particularly appropriate data packages (#94) use_lifecycle_badge() creates badge describing current stage project lifecycle (#48). use_pkgdown() creates basics needed pkgdown website (#88). use_r(\"foo\") creates edit R/foo.R file. test file open, use_r() open corresponding .R file (#105). use_tidy_versions() sets minimum version requirement dependencies.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"bug-fixes-and-improvements-1-1-0","dir":"Changelog","previous_headings":"","what":"Bug fixes and improvements","title":"usethis 1.1.0","text":"use_dev_version() now correctly updates Version field package description file. (@tjmahr, #104) use_revdep() now also git-ignores SQLite database (#107). use_tidy_eval() tweaked reflect current guidance (#106)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-100","dir":"Changelog","previous_headings":"","what":"usethis 1.0.0","title":"usethis 1.0.0","text":"CRAN release: 2017-10-22 new package extracts many functions previously lived devtools, well providing building blocks can create helpers. well many new helpers listed , three main improvements package: support general R projects, packages. notion “active” project commands operate . Refined output. usethis gradually evolving towards supporting general R “projects”, just packages. still work progress, please let know use function think work projects doesn’t. can also try new create_project() creates basic RStudio project. concept working directory “base path” refined. Rather using argument specify active project, use_ functions now use global active project setting, returned proj_get(). cached throughout session, although updated create_package() create_project(). ’ll now get clear error attempt use_something() outside project, create_something() warn ’re trying create inside existing project. output usethis commands reviewed informative overwhelming. usethis takes advantage colour (using crayon RStudio 1.1) help chunk output clearly differentiate need vs. done .","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-0-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.0.0","text":"use_apl2_license() want use Apache 2.0 license. use_depsy_badge() allows including Depsy badge (@gvegayon, #68). use_dev_package() works like use_package() also adds repo Remotes field (#32). use_github_labels() automatically set standard set labels, optionally removing default labels (#1). use_pipe() creates template use magrittr’s %>% package (#15). use_tidy_ci() sets travis codecov using tidyverse conventions (#14) use_tidy_description() puts description fields standard order alphabetises dependencies. use_tidy_eval() imports re-exports recommend set tidy eval helpers package uses tidy eval (#46). use_usethis() opens .Rprofile gives code copy paste .","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-edit-functions-1-0-0","dir":"Changelog","previous_headings":"","what":"New edit functions","title":"usethis 1.0.0","text":"new class functions make easy edit common config files: edit_r_profile_user() opens .Rprofile edit_r_environ_user() opens .Renviron edit_r_makevars_user() opens .R/Makevars edit_git_config_user() opens .gitconfig edit_git_ignore_user() opens .gitignore edit_rstudio_snippets(type) opens ~/R/snippets/{type}.snippets","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"updates-1-0-0","dir":"Changelog","previous_headings":"","what":"Updates","title":"usethis 1.0.0","text":"use_coverage(\"codecov\") now sets default threshold 1% try reduce false positives (#8). use_description() now sets ByteCompile: true can benefit byte compiler (#29) license functions (use_mit_license(), use_apl2_license(), use_gpl3_license()) save copy standard license text LICENSE.md, added .Rbuildignore. allows follow standard licensing best practices adhering CRANs requirements (#10). use_package_doc() uses modern roxygen2 template requires less duplication. use_test() use name currently open file RStudio don’t supply explicit name (#89). use_readme_rmd() now puts images man/figures/ longer adds .Rbuildgnore. ensures rendered README.md also work CRAN (#16, #19). first chunk now uses include = FALSE named setup (#19). use_revdep() creates structure use revdepcheck package, preferred way run revdepchecks. (#33)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"building-blocks-1-0-0","dir":"Changelog","previous_headings":"","what":"Building blocks","title":"usethis 1.0.0","text":"New use_badge() adding badge README. Now prints todo message badge already exist. use_directory() now exported (#27).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"bug-fixes-and-minor-improvements-1-0-0","dir":"Changelog","previous_headings":"","what":"Bug fixes and minor improvements","title":"usethis 1.0.0","text":"Functions require code copied now automatically put code clipboard available (#52). create_package() longer creates dependency current version use_build_ignore() now strips trailing / use_git() restart RStudio needed (possible) (#42). use_github() now organisation parameter can create repos organisations (#4). use_template() use_test() now convert title slug contains lowercase letters, numbers, -. use_vignette() now adds *.html *.R .gitgnore don’t accidentally add compiled vignette products (#35). use_travis_badge() use_appveyor_badge() now exported functions, can used even ci separately set (#765, @smwindecker).","code":""}]
+[{"path":[]},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://usethis.r-lib.org/dev/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to usethis","title":"Contributing to usethis","text":"outlines propose change usethis. detailed info contributing , tidyverse packages, please see development contributing guide.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to usethis","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to usethis","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to usethis","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"r-lib/usethis\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to usethis","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://usethis.r-lib.org/dev/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to usethis","text":"Please note usethis project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://usethis.r-lib.org/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2020 usethis authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with usethis","title":"Getting help with usethis","text":"Thanks using usethis! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with usethis","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty incredible ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with usethis","text":"Armed reprex, next step figure ask. ’s question: start community.rstudio.com, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://usethis.r-lib.org/dev/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with usethis","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"markdown-image-link","dir":"Articles","previous_headings":"","what":"Markdown image link","title":"Exploring badge accessibility","text":"usethis currently inserts badges special “badge block” README, fenced HTML comment tags. Within badge block, badge hyperlinked image, alt text. basic form: Note alt_text static label explaining badge’s purpose, whereas dynamic information baked externally-served image. usethis definitely controls alt_text, something ’d like feedback .","code":"[](http://path/to/more/details)"},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"badge-image","dir":"Articles","previous_headings":"","what":"Badge image","title":"Exploring badge accessibility","text":"badges days tend SVG files, fortunate, since SVGs can carry attributes support accessibility. demonstrate custom badge generated via shields.io web service. request badge URL: badge, hyperlink set https://shields.io/. badge inside HTML comment block, like usethis README badges. ’ve prefixed every field can influence “”; 3 fields: alt text. label. static text appears left side badge, grey background, describes badge. message. text appears right side badge, colored background. often dynamic part, color text convey dynamic fact, e.g. “passing” green background “failing” red background. Now inspect badge SVG. apologize advance amount data displayed , seems good show one badge full gory detail. Later, display badge information selectively. understanding two main pieces metadata title aria-label attribute. reveal just two items badge: badge carries information title aria-label, “my_label: my_message”. interested learn information included twice good bad thing screen reader experience.","code":"https://img.shields.io/badge/my__label-my__message-orange library(xml2) library(purrr) inspect_badge <- function(badge) { badge %>% read_xml() %>% as_list() %>% pluck(\"svg\") } inspect_badge(\"https://img.shields.io/badge/my__label-my__message-orange\") #> $title #> $title[[1]] #> [1] \"my_label: my_message\" #> #> #> $linearGradient #> $linearGradient$stop #> list() #> attr(,\"offset\") #> [1] \"0\" #> attr(,\"stop-color\") #> [1] \"#bbb\" #> attr(,\"stop-opacity\") #> [1] \".1\" #> #> $linearGradient$stop #> list() #> attr(,\"offset\") #> [1] \"1\" #> attr(,\"stop-opacity\") #> [1] \".1\" #> #> attr(,\"id\") #> [1] \"s\" #> attr(,\"x2\") #> [1] \"0\" #> attr(,\"y2\") #> [1] \"100%\" #> #> $clipPath #> $clipPath$rect #> list() #> attr(,\"width\") #> [1] \"144\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"rx\") #> [1] \"3\" #> attr(,\"fill\") #> [1] \"#fff\" #> #> attr(,\"id\") #> [1] \"r\" #> #> $g #> $g$rect #> list() #> attr(,\"width\") #> [1] \"61\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"fill\") #> [1] \"#555\" #> #> $g$rect #> list() #> attr(,\"x\") #> [1] \"61\" #> attr(,\"width\") #> [1] \"83\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"fill\") #> [1] \"#fe7d37\" #> #> $g$rect #> list() #> attr(,\"width\") #> [1] \"144\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"fill\") #> [1] \"url(#s)\" #> #> attr(,\"clip-path\") #> [1] \"url(#r)\" #> #> $g #> $g$text #> $g$text[[1]] #> [1] \"my_label\" #> #> attr(,\"aria-hidden\") #> [1] \"true\" #> attr(,\"x\") #> [1] \"315\" #> attr(,\"y\") #> [1] \"150\" #> attr(,\"fill\") #> [1] \"#010101\" #> attr(,\"fill-opacity\") #> [1] \".3\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"textLength\") #> [1] \"510\" #> #> $g$text #> $g$text[[1]] #> [1] \"my_label\" #> #> attr(,\"x\") #> [1] \"315\" #> attr(,\"y\") #> [1] \"140\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"fill\") #> [1] \"#fff\" #> attr(,\"textLength\") #> [1] \"510\" #> #> $g$text #> $g$text[[1]] #> [1] \"my_message\" #> #> attr(,\"aria-hidden\") #> [1] \"true\" #> attr(,\"x\") #> [1] \"1015\" #> attr(,\"y\") #> [1] \"150\" #> attr(,\"fill\") #> [1] \"#010101\" #> attr(,\"fill-opacity\") #> [1] \".3\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"textLength\") #> [1] \"730\" #> #> $g$text #> $g$text[[1]] #> [1] \"my_message\" #> #> attr(,\"x\") #> [1] \"1015\" #> attr(,\"y\") #> [1] \"140\" #> attr(,\"transform\") #> [1] \"scale(.1)\" #> attr(,\"fill\") #> [1] \"#fff\" #> attr(,\"textLength\") #> [1] \"730\" #> #> attr(,\"fill\") #> [1] \"#fff\" #> attr(,\"text-anchor\") #> [1] \"middle\" #> attr(,\"font-family\") #> [1] \"Verdana,Geneva,DejaVu Sans,sans-serif\" #> attr(,\"text-rendering\") #> [1] \"geometricPrecision\" #> attr(,\"font-size\") #> [1] \"110\" #> #> attr(,\"width\") #> [1] \"144\" #> attr(,\"height\") #> [1] \"20\" #> attr(,\"role\") #> [1] \"img\" #> attr(,\"aria-label\") #> [1] \"my_label: my_message\" #> attr(,\"xmlns\") #> [1] \"http://www.w3.org/2000/svg\" #> attr(,\"xmlns:xlink\") #> [1] \"http://www.w3.org/1999/xlink\" inspect_badge <- function(badge) { x <- badge %>% read_xml() %>% as_list() %>% pluck(\"svg\") list( title = pluck(x, \"title\", 1), `aria-label` = pluck(x, attr_getter(\"aria-label\")) ) } inspect_badge(\"https://img.shields.io/badge/my__label-my__message-orange\") #> $title #> [1] \"my_label: my_message\" #> #> $`aria-label` #> [1] \"my_label: my_message\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"shields-io-badges-are-accessible-today","dir":"Articles","previous_headings":"Badge image","what":"shields.io badges are accessible today","title":"Exploring badge accessibility","text":"One reasons inspected shields.io badge may provide usable alternative service whose official badge (yet?) screen-reader-friendly. custom badge completely static. shields.io also supports custom dynamic badges, necessary information (label, message, color) available suitable JSON endpoint. Finally, relevant usethis, shields.io offers pre-configured dynamic badges commonly “badged” services, including GitHub Actions Codecov. shields.io badge usethis’s R CMD check workflow GitHub Actions: , indicating fields control my_alt_text my_label, ’s easier get feedback usethis . title aria-label badge : Now take inventory main badges inserted usethis things stand re: accessibility.","code":"inspect_badge(\"https://img.shields.io/github/workflow/status/r-lib/usethis/R-CMD-check?label=my_label-R-CMD-check\") #> $title #> [1] \"my_label-R-CMD-check: https://github.com/badges/shields/issues/8671\" #> #> $`aria-label` #> [1] \"my_label-R-CMD-check: https://github.com/badges/shields/issues/8671\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"r-cmd-check-status","dir":"Articles","previous_headings":"","what":"R CMD check status","title":"Exploring badge accessibility","text":"generally obtain current R CMD check status GitHub Actions workflow. official badge provided GitHub: title aria-label badge : time writing (late December 2021), badge include information. requested GitHub’s Actions Packages Feedback forum response GitHub encouraging. Hopefully native badge gain improved accessibility early 2022. https://github.com/github/feedback/discussions/8974 meantime, one use shields.io badge report R CMD check status, demonstrated previous section. maintainer one-, GitHub badge upgrade slow coming, implement usethis::use_github_actions_badge().","code":"inspect_badge(\"https://github.com/r-lib/usethis/actions/workflows/R-CMD-check.yaml/badge.svg\") #> $title #> [1] \"R-CMD-check - passing\" #> #> $`aria-label` #> NULL"},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"package-lifecycle","dir":"Articles","previous_headings":"","what":"Package lifecycle","title":"Exploring badge accessibility","text":"usethis::use_lifecycle_badge() declares developmental stage package, using framework https://lifecycle.r-lib.org/articles/stages.html. function already inserts shields.io badge: title aria-label badge : ’s possible usethis using badge “owned” lifecycle package. think don’t now, declaring lifecycle stage whole package necessarily imply need take formal dependency lifecycle package, usually causes badges copied man/figures/ directory. Also, badges shipped lifecycle package currently accessible, another reason use . opened issue (https://github.com/r-lib/lifecycle/issues/117). relatively easy fix, since static badges. done, package maintainers need update SVGs stored man/figures/.","code":"inspect_badge(\"https://img.shields.io/badge/lifecycle-stable-brightgreen.svg\") #> $title #> [1] \"lifecycle: stable\" #> #> $`aria-label` #> [1] \"lifecycle: stable\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"cran-status","dir":"Articles","previous_headings":"","what":"CRAN status","title":"Exploring badge accessibility","text":"usethis::use_cran_badge() places badge indicates package version available CRAN. badge served METACRAN (https://www.r-pkg.org) maintainer Gábor Csárdi already incorporated aria-label badges (commit). available badges listed . ’s badge placed usethis::use_cran_badge(): title aria-label badge : time writing (late December 2021), aria-label present, title . interested know good situation using screen reader.","code":"inspect_badge(\"https://www.r-pkg.org/badges/version/usethis\") #> $title #> NULL #> #> $`aria-label` #> [1] \"CRAN 2.2.3\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"code-coverage","dir":"Articles","previous_headings":"","what":"Code coverage","title":"Exploring badge accessibility","text":"usethis::use_coverage(type = c(\"codecov\", \"coveralls\", ...) calls internal helper usethis:::use_codecov_badge() insert badge either Codecov Coveralls service. examples two badges (note usethis use Coveralls, ’m using different package demo): title aria-label badges:: time writing (late December 2021), neither badge offers title aria-label. badges shields.io Codecov Coveralls: title aria-label shields.io badges::","code":"inspect_badge(\"https://codecov.io/gh/r-lib/usethis/branch/main/graph/badge.svg\") #> $title #> NULL #> #> $`aria-label` #> NULL inspect_badge(\"https://coveralls.io/repos/github/trinker/sentimentr/badge.svg?branch=master\") #> $title #> NULL #> #> $`aria-label` #> NULL inspect_badge(\"https://img.shields.io/codecov/c/github/r-lib/usethis?label=test%20coverage&logo=codecov\") #> $title #> [1] \"test coverage: 59%\" #> #> $`aria-label` #> [1] \"test coverage: 59%\" inspect_badge(\"https://img.shields.io/coveralls/github/trinker/sentimentr?logo=coveralls\") #> $title #> [1] \"coverage: 19%\" #> #> $`aria-label` #> [1] \"coverage: 19%\""},{"path":"https://usethis.r-lib.org/dev/articles/badge-accessibility.html","id":"bioconductor","dir":"Articles","previous_headings":"","what":"Bioconductor","title":"Exploring badge accessibility","text":"package Bioconductor, usethis::use_bioc_badge() can used insert badge Bioconductor build status. badge: title aria-label badge: time writing (late December 2021), badge title aria-label. ’s immediately clear resolve , suspect Bioconductor receptive request create accessible badges.","code":"inspect_badge(\"http://www.bioconductor.org/shields/build/release/bioc/biocthis.svg\") #> $title #> NULL #> #> $`aria-label` #> NULL"},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"tldr-use-https-2fa-and-a-github-personal-access-token","dir":"Articles","previous_headings":"","what":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","title":"Managing Git(Hub) Credentials","text":"main recommendations : Adopt HTTPS Git transport protocol. Turn two-factor authentication GitHub account. Use personal access token (PAT) Git remote operations command line R. Allow tools store retrieve credentials Git credential store. previously set GitHub PAT .Renviron, stop . Next provide context rationale recommendations. following section, explain actually implement .","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"https-vs-ssh","dir":"Articles","previous_headings":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","what":"HTTPS vs SSH","title":"Managing Git(Hub) Credentials","text":"Instead HTTPS, use SSH. Many people valid reasons preferring SSH carry . recommendation HTTPS ’s easier SSH newcomers set correctly, especially Windows. GitHub also long recommended HTTPS new users. Finally, using HTTPS PAT kills two birds one stone: single credential can used authenticate GitHub regular Git server REST API. authenticate via SSH “regular” Git work, still set PAT work uses REST API.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"two-factor-authentication","dir":"Articles","previous_headings":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","what":"Two-factor authentication","title":"Managing Git(Hub) Credentials","text":"Turning two-factor authentication important online accounts just good idea, general. example, make 2FA hard requirement members tidyverse r-lib GitHub organizations. past, activating 2FA also forced using HTTPS use PAT, instead “username + password”, operations like git push. Using PAT now absolute requirement, operations using HTTPS protocol, longer anything 2FA. background deprecation “username + password” can found GitHub’s blog post Token authentication requirements Git operations.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"git-credential-helpers-and-the-credential-store","dir":"Articles","previous_headings":"TL;DR: Use HTTPS, 2FA, and a GitHub Personal Access Token","what":"Git credential helpers and the credential store","title":"Managing Git(Hub) Credentials","text":"’s awkward provide credentials every single Git transaction, ’s customary let system remember credentials. Git uses -called credential helpers , happily, tend “just work” days (especially, macOS Windows) 1. Git credential helpers take advantage official OS-provided credential stores, possible, macOS Keychain Windows Credential Manager. Recent innovations gert gh mean Git/GitHub operations R can also store discover credentials using official Git credential helpers. means can stop storing GitHub PATs plain text startup file, like .Renviron 2. , turn, reduces risk accidentally leaking credentials.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"practical-instructions","dir":"Articles","previous_headings":"","what":"Practical instructions","title":"Managing Git(Hub) Credentials","text":"actually implement recommendations? diagnostic functions usethis::gh_token_help() usethis::git_sitrep() offer advice see , directly R session.","code":""},{"path":"https://usethis.r-lib.org/dev/articles/git-credentials.html","id":"adopt-https","dir":"Articles","previous_headings":"Practical instructions","what":"Adopt HTTPS","title":"Managing Git(Hub) Credentials","text":"Make sure use HTTPS URLs, SSH, cloning repos adding new remotes: HTTPS URLs look like : https://github.com/. gives nicer display retina displays. logo also linked pkgdown site available (#536). creating new package, use create_tidy_package() start package following tidyverse standards (#461). NEWS.md development version use “(development version)” rather specific version (#440). pkgdown sites now built travis deployed automatically GitHub pages. use_pkgdown_travis() help set . starting release process, call use_release_issue() create release checklist issue (#338). Prior CRAN submission call use_tidy_release_test_env() update test environment section cran-comments() (#496). acceptance, try use_github_release() automatically create release. ’s created draft chance look publishing. use_vignette() includes standard initialisation chunk knitr::opts_chunk$set(comment = \"#>\", collapse = TRUE) used Rmds.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-not-already-mentioned-1-5-0","dir":"Changelog","previous_headings":"","what":"New functions not already mentioned","title":"usethis 1.5.0","text":"use_devtools() (#624), use_conflicted() (#362), use_reprex() (#465) help add useful packages .Rprofile. use_partial_warnings() helps user add standard warning block .Rprofile (#64). edit_r_buildignore() opens .Rbuildignore manual editing (#462, @bfgray3). use_lgpl_license() automates set LGL license (#448, @krlmlr). use_ccby_license() adds CCBY 4.0 license (#547, @njtierney). use_rcpp_armadillo() use_rcpp_eigen() set package use RcppArmadillo RcppEigen, respectively (#421, @coatless, @duckmayr). use_c(\"foo\") sets src/ creates src/foo.c (#117). use_covr_ignore() makes easy ignore files test coverage (#434). use_pkgdown_travis() helps set pkgdown automatic build--deploy Travis-CI GitHub Pages (#524). use_addin() setup RStudio addins (#353, @haozhu233). use_tutorial() creates new interactive R Markdown tutorial, implemented learnr package (@angela-li, #645). use_article() creates articles, vignettes automatically added .Rbuildignore. appear pkgdown sites, included package (#281). use_citation() creates basic CITATION template puts right place (#100).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"other-minor-bug-fixes-and-improvements-1-5-0","dir":"Changelog","previous_headings":"","what":"Other minor bug fixes and improvements","title":"usethis 1.5.0","text":"write_union() appends novel lines, remove duplicates existing lines (#583, @khailper). use_rcpp(\"foo\") now creates src/foo.cpp (#117). use_data() gains version argument defaults serialization format version 2 (#675). use_data_raw() accepts name --prepared dataset opens templated R script (#646). browse_github() now falls back CRAN organisation (warning) package doesn’t GitHub repo (#186). create_*() restore active project error part way , use proj_activate() (#453, #511). edit_r_profile() edit_r_environ() now respect environment variables R_PROFILE_USER R_ENVIRON_USER, respectively (#480). use_description() prints generated description (#287). use_description_field() longer sensitive whitespace, allows use_vignette() work even VignetteBuilder field spread multiple lines (#439). use_logo() can override existing logo user gives permission (#454). also produces retina appropriate logos default, matches aspect ratio http://hexb./sticker.html specification (#499). use_news_md() optionally commit. use_package() gains min_version argument specify minimum version requirement (#498). Set TRUE use currently installed version (#386). used use_tidy_eval() order require version 0.1.2 greater rlang (#484). use_pkgdown() now configurable site options (@jayhesselberth, #467), longer creates docs/ directory (#495). use_test() longer forces filename lowercase (#613, @stufield). use_test() include context() generated file used testthat 2.1.0 (future release testthat) (#325). use_tidy_description() sets Encoding field DESCRIPTION (#502, @krlmlr). use_tidy_eval() re-exports := (#595, @jonthegeek). use_tidy_versions() source argument can choose use local CRAN versions (#309). use_travis() gains ext argument, defaulting \"org\". Use ext = \"com\" https://travis-ci.com (@cderv, #500). use_version() asks committing. use_vignette() now title argument used YAML header (two places needed). vignettes also lose default author date fields (@rorynolan, #445), R Markdown starter material. gain standard setup chunk. use_version(\"dev\") now creates standard “(development version)” heading NEWS.md (#440). use_vignette() now checks vignette name valid (starts letter consists letters, numbers, hyphen, underscore) throws error (@akgold, #555). restart_rstudio() now returns FALSE RStudio project open, fixing issue caused errors helpers suggest restarting RStudio (@gadenbuie, #571).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"dependency-changes-1-5-0","dir":"Changelog","previous_headings":"","what":"Dependency changes","title":"usethis 1.5.0","text":"withr moves Suggests Imports. purrr yaml new Imports.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-140","dir":"Changelog","previous_headings":"","what":"usethis 1.4.0","title":"usethis 1.4.0","text":"CRAN release: 2018-08-14","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"file-system-1-4-0","dir":"Changelog","previous_headings":"","what":"File system","title":"usethis 1.4.0","text":"usethis file system operations now use fs package (#177). change usethis functions, users may notice features fs-mediated paths: Paths “tidy”, meaning / path separator never multiple trailing /. Paths UTF-8 encoded. Windows user’s home directory interpreted C:\\Users\\username (typical Unix-oriented tools, like Git ssh; also matches Python), opposed C:\\Users\\username\\Documents (R’s default Windows). Read fs::path_expand().","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"extending-or-wrapping-usethis-1-4-0","dir":"Changelog","previous_headings":"","what":"Extending or wrapping usethis","title":"usethis 1.4.0","text":"changes make easier others extend usethis, .e. create workflow packages specific organization, use usethis packages. proj_path() newly exported. Use build paths within active project. Like proj_get() proj_set(), aimed end users, rather use extension packages. End users use rprojroot simpler companion, , programmatically detect project build paths within (#415, #425). edit_file(), write_over(), write_union() newly exported helpers. mostly internal use, can also useful packages extend customize usethis (#344, #366, #389). use_template() longer errors user chooses overwrite existing file simply exits confirmation file unchanged (#348, #350, @boshek). getOption(\"usethis.quiet\", default = FALSE) consulted printing user-facing messages. Set option TRUE suppress output, e.g., use usethis functions quietly another package. example, use withr::local_options(list(usethis.quiet = TRUE)) calling function (#416, #424).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-4-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.4.0","text":"proj_sitrep() reports current working directory, active usethis project, active RStudio Project. Call function things seem weird ’re sure ’s wrong fix . Designed interactive use debugging, programmatic use (#426). use_tibble() minimum setup necessary package returns exports tibble. example, guarantees tibble print tibble (#324 @martinjhnhadley). use_logo() resizes adds logo package (#358, @jimhester). use_spell_check() adds whitelist words unit test spell check package documentation R CMD check (#285 @jeroen).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"other-small-changes-and-bug-fixes-1-4-0","dir":"Changelog","previous_headings":"","what":"Other small changes and bug fixes","title":"usethis 1.4.0","text":"usethis new logo! (#429) use_course() reports progress download (#276, #380). use_git() makes initial commit files user gives explicit consent (#378). create_from_github(): repo argument renamed repo_spec, since takes input form “OWNER/REPO” (#376). use_depsy_badge() defunct. Depsy project officially concluded longer maintained (#354). use_github() fails earlier, informative message, absence GitHub personal access token (PAT). Also looks PAT proactively usual environment variables (.e., GITHUB_PAT, GITHUB_TOKEN) (#320, #340, @cderv). logic setting DESCRIPTION fields create_package() use_description() got Spring Cleaning. Fields directly specified user take precedence, named list getOption(\"usethis.description\") consulted, finally defaults built usethis. use_description_defaults() new function reveals fields found options built usethis. Options specific one DESCRIPTION field, e.g. devtools.desc.license, longer supported. Instead, use single named list fields, preferably stored option named \"usethis.description\" (however,\"devtools.desc\" still consulted backwards compatibility). (#159, #233, #367)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"dependency-changes-1-4-0","dir":"Changelog","previous_headings":"","what":"Dependency changes","title":"usethis 1.4.0","text":"New Imports: fs, glue, utils longer Imports: backports, httr, rematch2, rmarkdown (moved Suggests), styler (moved Suggests)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-130","dir":"Changelog","previous_headings":"","what":"usethis 1.3.0","title":"usethis 1.3.0","text":"CRAN release: 2018-02-24 usethis website: https://usethis.r-lib.org (#217). includes article advice system setup, usethis R development generally. edit_*() functions now return target path, invisibly (#255). edit_git_ignore(scope = \"user\") prefers ~/.gitignore, detects existing ~/.gitignore_global, exists. new global gitignore file created, created ~/.gitignore recorded user’s git config core.excludesfile (#255). create_from_github() gains several arguments new functionality. protocol argument lets user convey whether remote URLs ssh https. case “fork clone”, original repo added upstream remote. now possible – although rarely necessary – directly specify GitHub PAT, credentials (git2r form), GitHub host (#214, #214, #253). use_github_labels() can create update colour arbitrary GitHub issue labels, defaulting set labels colours used tidyverse packages, now exposed via tidy_labels(). set now includes labels “good first issue” “help wanted” (#168, #249). appveyor_info() longer reverses repo’s URL image link. Corrects markdown produced use_appveyor_badge() (#240, @llrs). use_cran_badge() uses HTTPS URL CRAN badge image (#235, @jdblischak). create_package() create_project() return normalized path, even target directory pre-exist (#227, #228).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-3-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.3.0","text":"use_git_config() can set user’s Git name email, globally locally project/repo (#267). browse_github_pat() goes webpage GitHub user can create personal access token (PAT) GitHub API. user configures PAT, can use functions like create_from_github() use_github() easily create connect GitHub repos local projects. (#248, #257, @jeroen, via @jennybc). use_version() increments version active package, including interactive chooser. use_dev_version() now special case wrapper around . (#188, #223, @EmilHvitfeldt). use_tidy_github() creates standard set files make GitHub repository navigable users contributors: issue template, contributing guidelines, support documentation, code conduct. now placed .github/ subdirectory (#165, @batpigandme). use_bioc_badge creates Bioconductor badge links build report (#271, @LiNk-NY). use_binder_badge() creates badge indicating repository can launched executable environment via Binder (#242, @uribo).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-120","dir":"Changelog","previous_headings":"","what":"usethis 1.2.0","title":"usethis 1.2.0","text":"CRAN release: 2018-01-19","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-2-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.2.0","text":"use_course() downloads folder’s worth materials ZIP file, deliberate choices around default folder name location. Developed use start workshop. Helps participants obtain materials , e.g., DropBox folder GitHub repo (#196). use_blank_slate() provides way opt RStudio workflow user’s workspace neither saved reloaded R sessions. Automated scope = \"project\". Provides UI instructions scope = \"user\", now (#139). use_tidy_style() styles entire project according https://style.tidyverse.org (#72, #197 @lorenzwalthert). GitHub conventions common tidyverse packages enacted use_tidy_contributing(), use_tidy_issue_template(), use_tidy_support() (@batpigandme, #143, #166). changes New projects don’t exhibit obvious criteria “project” include sentinel, empty file named ., can recognized project. Project launching switching works RStudio server (#115, #129). use_template() newly exported, packages can provide templating functions using framework (@ijlyttle #120). use_readme_rmd() use_readme_md() work, similar fashion, projects package (#131, #135). use_readme_rmd() creates pre-commit git hook, help keep README.Rmd README.md sync (@PeteHaitch #41). Substantial increase unit test coverage.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-110","dir":"Changelog","previous_headings":"","what":"usethis 1.1.0","title":"usethis 1.1.0","text":"CRAN release: 2017-11-17","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-helpers-1-1-0","dir":"Changelog","previous_headings":"","what":"New helpers","title":"usethis 1.1.0","text":"browse_github(), browse_github_issues(), browse_github_pulls(), browse_cran() browse_travis() open useful websites related current project named package. (#96, #103). create_from_github() creates project existing GitHub repository, forking needed (#109). use_cc0_license() applies CC0 license, particularly appropriate data packages (#94) use_lifecycle_badge() creates badge describing current stage project lifecycle (#48). use_pkgdown() creates basics needed pkgdown website (#88). use_r(\"foo\") creates edit R/foo.R file. test file open, use_r() open corresponding .R file (#105). use_tidy_versions() sets minimum version requirement dependencies.","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"bug-fixes-and-improvements-1-1-0","dir":"Changelog","previous_headings":"","what":"Bug fixes and improvements","title":"usethis 1.1.0","text":"use_dev_version() now correctly updates Version field package description file. (@tjmahr, #104) use_revdep() now also git-ignores SQLite database (#107). use_tidy_eval() tweaked reflect current guidance (#106)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"usethis-100","dir":"Changelog","previous_headings":"","what":"usethis 1.0.0","title":"usethis 1.0.0","text":"CRAN release: 2017-10-22 new package extracts many functions previously lived devtools, well providing building blocks can create helpers. well many new helpers listed , three main improvements package: support general R projects, packages. notion “active” project commands operate . Refined output. usethis gradually evolving towards supporting general R “projects”, just packages. still work progress, please let know use function think work projects doesn’t. can also try new create_project() creates basic RStudio project. concept working directory “base path” refined. Rather using argument specify active project, use_ functions now use global active project setting, returned proj_get(). cached throughout session, although updated create_package() create_project(). ’ll now get clear error attempt use_something() outside project, create_something() warn ’re trying create inside existing project. output usethis commands reviewed informative overwhelming. usethis takes advantage colour (using crayon RStudio 1.1) help chunk output clearly differentiate need vs. done .","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-functions-1-0-0","dir":"Changelog","previous_headings":"","what":"New functions","title":"usethis 1.0.0","text":"use_apl2_license() want use Apache 2.0 license. use_depsy_badge() allows including Depsy badge (@gvegayon, #68). use_dev_package() works like use_package() also adds repo Remotes field (#32). use_github_labels() automatically set standard set labels, optionally removing default labels (#1). use_pipe() creates template use magrittr’s %>% package (#15). use_tidy_ci() sets travis codecov using tidyverse conventions (#14) use_tidy_description() puts description fields standard order alphabetises dependencies. use_tidy_eval() imports re-exports recommend set tidy eval helpers package uses tidy eval (#46). use_usethis() opens .Rprofile gives code copy paste .","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"new-edit-functions-1-0-0","dir":"Changelog","previous_headings":"","what":"New edit functions","title":"usethis 1.0.0","text":"new class functions make easy edit common config files: edit_r_profile_user() opens .Rprofile edit_r_environ_user() opens .Renviron edit_r_makevars_user() opens .R/Makevars edit_git_config_user() opens .gitconfig edit_git_ignore_user() opens .gitignore edit_rstudio_snippets(type) opens ~/R/snippets/{type}.snippets","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"updates-1-0-0","dir":"Changelog","previous_headings":"","what":"Updates","title":"usethis 1.0.0","text":"use_coverage(\"codecov\") now sets default threshold 1% try reduce false positives (#8). use_description() now sets ByteCompile: true can benefit byte compiler (#29) license functions (use_mit_license(), use_apl2_license(), use_gpl3_license()) save copy standard license text LICENSE.md, added .Rbuildignore. allows follow standard licensing best practices adhering CRANs requirements (#10). use_package_doc() uses modern roxygen2 template requires less duplication. use_test() use name currently open file RStudio don’t supply explicit name (#89). use_readme_rmd() now puts images man/figures/ longer adds .Rbuildgnore. ensures rendered README.md also work CRAN (#16, #19). first chunk now uses include = FALSE named setup (#19). use_revdep() creates structure use revdepcheck package, preferred way run revdepchecks. (#33)","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"building-blocks-1-0-0","dir":"Changelog","previous_headings":"","what":"Building blocks","title":"usethis 1.0.0","text":"New use_badge() adding badge README. Now prints todo message badge already exist. use_directory() now exported (#27).","code":""},{"path":"https://usethis.r-lib.org/dev/news/index.html","id":"bug-fixes-and-minor-improvements-1-0-0","dir":"Changelog","previous_headings":"","what":"Bug fixes and minor improvements","title":"usethis 1.0.0","text":"Functions require code copied now automatically put code clipboard available (#52). create_package() longer creates dependency current version use_build_ignore() now strips trailing / use_git() restart RStudio needed (possible) (#42). use_github() now organisation parameter can create repos organisations (#4). use_template() use_test() now convert title slug contains lowercase letters, numbers, -. use_vignette() now adds *.html *.R .gitgnore don’t accidentally add compiled vignette products (#35). use_travis_badge() use_appveyor_badge() now exported functions, can used even ci separately set (#765, @smwindecker).","code":""}]