diff --git a/dev/CODE_OF_CONDUCT.html b/dev/CODE_OF_CONDUCT.html index 48428462..73362f50 100644 --- a/dev/CODE_OF_CONDUCT.html +++ b/dev/CODE_OF_CONDUCT.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/LICENSE-text.html b/dev/LICENSE-text.html index a3c9e5c7..2fe98ff0 100644 --- a/dev/LICENSE-text.html +++ b/dev/LICENSE-text.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/LICENSE.html b/dev/LICENSE.html index 741ba19c..775047c4 100644 --- a/dev/LICENSE.html +++ b/dev/LICENSE.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/MAINTENANCE.html b/dev/MAINTENANCE.html index 38bc9534..978ce6f7 100644 --- a/dev/MAINTENANCE.html +++ b/dev/MAINTENANCE.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/articles/dependencies.html b/dev/articles/dependencies.html index 7fac4347..71e1ea01 100644 --- a/dev/articles/dependencies.html +++ b/dev/articles/dependencies.html @@ -29,7 +29,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/articles/index.html b/dev/articles/index.html index 8b555226..cd88545f 100644 --- a/dev/articles/index.html +++ b/dev/articles/index.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/authors.html b/dev/authors.html index b6a5910c..22699163 100644 --- a/dev/authors.html +++ b/dev/authors.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 @@ -92,13 +92,13 @@ Citation Csárdi G, Hester J, Wickham H, Chang W, Morgan M, Tenenbaum D (2024). remotes: R Package Installation from Remote Repositories, Including 'GitHub'. -R package version 2.4.2.9000, https://github.com/r-lib/remotes#readme, https://remotes.r-lib.org. +R package version 2.5.0.9000, https://github.com/r-lib/remotes#readme, https://remotes.r-lib.org. @Manual{, title = {remotes: R Package Installation from Remote Repositories, Including 'GitHub'}, author = {Gábor Csárdi and Jim Hester and Hadley Wickham and Winston Chang and Martin Morgan and Dan Tenenbaum}, year = {2024}, - note = {R package version 2.4.2.9000, https://github.com/r-lib/remotes#readme}, + note = {R package version 2.5.0.9000, https://github.com/r-lib/remotes#readme}, url = {https://remotes.r-lib.org}, } diff --git a/dev/index.html b/dev/index.html index d9eaed9d..ed22da92 100644 --- a/dev/index.html +++ b/dev/index.html @@ -35,7 +35,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/news/index.html b/dev/news/index.html index 5a6e32cf..5daff29c 100644 --- a/dev/news/index.html +++ b/dev/news/index.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 @@ -50,6 +50,22 @@ Source: NEWS.md + +remotes (development version) + + +remotes 2.5.0CRAN release: 2024-03-17 + +install_github() now uses credentials from the git credential store, if GITHUB_PAT and GITHUB_TOKEN are not set. +The Remotes field in DESCRIPTION now accepts explicit package names: <pkgname>=<type>::<username>/<repo> (#719, @heavywatal). + +dev_package_deps() now works for packages with Enhances dependencies (#711, @maksymiuks). + +install_dev() now ignores a trailing slash (#692, @krlmlr). +System requirements now support Ubuntu 22.04. + +local_package_deps() now errors for non-existent directories (#772, @MatthieuStigler). + remotes 2.4.2CRAN release: 2021-11-30 Gábor Csárdi is now the maintainer. diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index b313e78d..f5cb95f4 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.7 pkgdown_sha: ~ articles: dependencies: dependencies.html -last_built: 2024-03-17T12:27Z +last_built: 2024-03-17T18:11Z urls: reference: https://remotes.r-lib.org/reference article: https://remotes.r-lib.org/articles diff --git a/dev/reference/available_packages.html b/dev/reference/available_packages.html index ba6b6b37..b1cbf7f2 100644 --- a/dev/reference/available_packages.html +++ b/dev/reference/available_packages.html @@ -14,7 +14,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/bioc_install_repos.html b/dev/reference/bioc_install_repos.html index 8f58eb8d..5c081b31 100644 --- a/dev/reference/bioc_install_repos.html +++ b/dev/reference/bioc_install_repos.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/download.html b/dev/reference/download.html index 0148fac9..1570c755 100644 --- a/dev/reference/download.html +++ b/dev/reference/download.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/download_version.html b/dev/reference/download_version.html index 9a7c419b..088d60fa 100644 --- a/dev/reference/download_version.html +++ b/dev/reference/download_version.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/git_credentials.html b/dev/reference/git_credentials.html index 06111be6..5daabd54 100644 --- a/dev/reference/git_credentials.html +++ b/dev/reference/git_credentials.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/github_refs.html b/dev/reference/github_refs.html index b027144e..9b2efbae 100644 --- a/dev/reference/github_refs.html +++ b/dev/reference/github_refs.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/github_remote.html b/dev/reference/github_remote.html index 2a76b17c..87f29703 100644 --- a/dev/reference/github_remote.html +++ b/dev/reference/github_remote.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/gitlab_pat.html b/dev/reference/gitlab_pat.html index b8bd39f4..8ac167ad 100644 --- a/dev/reference/gitlab_pat.html +++ b/dev/reference/gitlab_pat.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/index.html b/dev/reference/index.html index 94e166e0..4979a84d 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_bioc.html b/dev/reference/install_bioc.html index 01bedcc0..eb85143d 100644 --- a/dev/reference/install_bioc.html +++ b/dev/reference/install_bioc.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_bitbucket.html b/dev/reference/install_bitbucket.html index 11cf048f..8398fe68 100644 --- a/dev/reference/install_bitbucket.html +++ b/dev/reference/install_bitbucket.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_cran.html b/dev/reference/install_cran.html index 7b4e6e2c..15feb704 100644 --- a/dev/reference/install_cran.html +++ b/dev/reference/install_cran.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_deps.html b/dev/reference/install_deps.html index 1933e5ba..5c51af41 100644 --- a/dev/reference/install_deps.html +++ b/dev/reference/install_deps.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_dev.html b/dev/reference/install_dev.html index 63bcd314..8b42c3e9 100644 --- a/dev/reference/install_dev.html +++ b/dev/reference/install_dev.html @@ -16,7 +16,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_git.html b/dev/reference/install_git.html index 9a026eea..a7aca4b5 100644 --- a/dev/reference/install_git.html +++ b/dev/reference/install_git.html @@ -14,7 +14,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_github.html b/dev/reference/install_github.html index 5d7783ea..5d79f8cf 100644 --- a/dev/reference/install_github.html +++ b/dev/reference/install_github.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_gitlab.html b/dev/reference/install_gitlab.html index b81efaf1..34538948 100644 --- a/dev/reference/install_gitlab.html +++ b/dev/reference/install_gitlab.html @@ -16,7 +16,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_local.html b/dev/reference/install_local.html index 55959051..9cdb0f30 100644 --- a/dev/reference/install_local.html +++ b/dev/reference/install_local.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_remote.html b/dev/reference/install_remote.html index bb0eaf82..39a665d2 100644 --- a/dev/reference/install_remote.html +++ b/dev/reference/install_remote.html @@ -22,7 +22,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_svn.html b/dev/reference/install_svn.html index 9e3ea7be..906a45a8 100644 --- a/dev/reference/install_svn.html +++ b/dev/reference/install_svn.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_url.html b/dev/reference/install_url.html index b6c15eb0..d457298f 100644 --- a/dev/reference/install_url.html +++ b/dev/reference/install_url.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/install_version.html b/dev/reference/install_version.html index ee810507..b3aa60d6 100644 --- a/dev/reference/install_version.html +++ b/dev/reference/install_version.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/package_deps.html b/dev/reference/package_deps.html index 74fe2476..89998477 100644 --- a/dev/reference/package_deps.html +++ b/dev/reference/package_deps.html @@ -16,7 +16,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/parse-git-repo.html b/dev/reference/parse-git-repo.html index 5c903807..d30326e0 100644 --- a/dev/reference/parse-git-repo.html +++ b/dev/reference/parse-git-repo.html @@ -32,7 +32,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/remotes-package.html b/dev/reference/remotes-package.html index 1e21d48f..9b757549 100644 --- a/dev/reference/remotes-package.html +++ b/dev/reference/remotes-package.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/standardise_dep.html b/dev/reference/standardise_dep.html index 2b0bde06..8facd5a2 100644 --- a/dev/reference/standardise_dep.html +++ b/dev/reference/standardise_dep.html @@ -10,7 +10,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/system_requirements.html b/dev/reference/system_requirements.html index 87a3b1e0..37ace37d 100644 --- a/dev/reference/system_requirements.html +++ b/dev/reference/system_requirements.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/reference/update_packages.html b/dev/reference/update_packages.html index 1f74dce2..cc7c2841 100644 --- a/dev/reference/update_packages.html +++ b/dev/reference/update_packages.html @@ -12,7 +12,7 @@ remotes - 2.4.2.9000 + 2.5.0.9000 diff --git a/dev/search.json b/dev/search.json index 651ad805..79684c2a 100644 --- a/dev/search.json +++ b/dev/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.r-lib.org/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2021 remotes 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://remotes.r-lib.org/dev/MAINTENANCE.html","id":"current-state","dir":"","previous_headings":"","what":"Current state","title":"NA","text":"Remotes mostly stable works vast majority people. However accumulates steady stream issues pull requests. Many issues general installation problems unrelated remotes , often better addressed community site. pull requests extensions code hosting platforms, tweaks ones don’t use regularly (like GitLab). makes somewhat challenging review accept, platform don’t typically use easy things break future. addition testing general challenge, many tests require internet access use hourly rate limits, makes flaky test suite pretty slow overall. also Makefile needs run code change, easy forget practice.","code":""},{"path":"https://remotes.r-lib.org/dev/MAINTENANCE.html","id":"known-outstanding-issues","dir":"","previous_headings":"","what":"Known outstanding issues","title":"NA","text":"remotes contains bundled PAT make using remotes CI services avoid rate limits. Unfortunately bundled PAT somewhat frequently gets invalidated user commits somewhere GitHub GitHub automatically scans new commits PATs invalidates . happens release new version remotes new PAT. damage done somewhat limited days, GitHub Actions workflows default use automatic GITHUB_TOKEN PAT, builds affected. can affect builds CI systems however. workaround user setup PAT rather relying built one. install.packages() known issue mix binary source packages, like package recently released CRAN binary yet built. can try install packages wrong order little user remotes can fix . https://bugs.r-project.org/show_bug.cgi?id=17864 Fixing require remotes handle installation ordering already , pak . install.packages() potentially patched fix problem, getting good reproducible example seems challenging R core unresponsive issue. known incompatibility multiple sets credentials needed. instance repositories need private GitHub account need public one, don’t PAT access. don’t believe easy implement solution problem given current code. workaround use URL remote private stuff instead GitHub remote. also ongoing issues GitLab remotes various scenarios private repositories. Unfortunately don’t use GitLab enough really smooth rough edges.","code":""},{"path":"https://remotes.r-lib.org/dev/MAINTENANCE.html","id":"future-directions","dir":"","previous_headings":"","what":"Future directions","title":"NA","text":"Ideally remotes marked superseded additional development around package installation occur either pak renv.","code":""},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"package-remotes","dir":"Articles","previous_headings":"","what":"Package remotes","title":"Dependency resolution for R package development","text":"Remotes, just like devtools, supports package dependency installation packages yet standard package repository CRAN Bioconductor. can mark regular dependency defined Depends, Imports, Suggests Enhances fields installed remote location adding remote location Remotes DESCRIPTION file. cause remotes download install specified location, instead CRAN. remote dependencies specified Remotes described following form. type optional parameter. type missing default install GitHub. Additional remote dependencies separated commas, just like normal dependencies elsewhere DESCRIPTION file.","code":"Remotes: [type::], [type2::]"},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"github","dir":"Articles","previous_headings":"Package remotes","what":"GitHub","title":"Dependency resolution for R package development","text":"GitHub commonly used unofficial package distribution R, ’s default: can also specify specific hash, tag, pull request (using syntax install_github() want particular commit. Otherwise latest commit default branch used. special @*release syntax install latest release: type ‘github’ can specified, required","code":"Remotes: r-lib/testthat Remotes: r-lib/httr@v0.4, klutometis/roxygen#142, r-lib/testthat@c67018fa4970 Remotes: r-lib/testthat@*release Remotes: github::tidyverse/ggplot2"},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"other-sources","dir":"Articles","previous_headings":"Package remotes","what":"Other sources","title":"Dependency resolution for R package development","text":"currently supported install sources available, see ‘See Also’ section ?install_github complete list.","code":"# GitLab Remotes: gitlab::jimhester/covr # Git Remotes: git::git@bitbucket.org:djnavarro/lsr.git, git::https://github.com/igraph/rigraph.git@main # Bitbucket Remotes: bitbucket::sulab/mygene.r@default, djnavarro/lsr # Bioconductor Remotes: bioc::3.3/SummarizedExperiment#117513, bioc::release/Biobase # SVN Remotes: svn::https://github.com/tidyverse/stringr # URL Remotes: url::https://github.com/tidyverse/stringr/archive/HEAD.zip # Local Remotes: local::/pkgs/testthat"},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"cran-submission","dir":"Articles","previous_headings":"Package remotes","what":"CRAN submission","title":"Dependency resolution for R package development","text":"submit package CRAN, dependencies must also available CRAN. reason, devtools::release() warn try release package Remotes field.","code":""},{"path":"https://remotes.r-lib.org/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Gábor Csárdi. Author, maintainer. Jim Hester. Author. Hadley Wickham. Author. Winston Chang. Author. Martin Morgan. Author. Dan Tenenbaum. Author. . Copyright holder, funder. Ascent Digital Services. Copyright holder.","code":""},{"path":"https://remotes.r-lib.org/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Csárdi G, Hester J, Wickham H, Chang W, Morgan M, Tenenbaum D (2024). remotes: R Package Installation Remote Repositories, Including 'GitHub'. R package version 2.4.2.9000, https://github.com/r-lib/remotes#readme, https://remotes.r-lib.org.","code":"@Manual{, title = {remotes: R Package Installation from Remote Repositories, Including 'GitHub'}, author = {Gábor Csárdi and Jim Hester and Hadley Wickham and Winston Chang and Martin Morgan and Dan Tenenbaum}, year = {2024}, note = {R package version 2.4.2.9000, https://github.com/r-lib/remotes#readme}, url = {https://remotes.r-lib.org}, }"},{"path":"https://remotes.r-lib.org/dev/index.html","id":"remotes","dir":"","previous_headings":"","what":"R Package Installation from Remote Repositories, Including GitHub","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Install R Packages remote local repositories, including GitHub, GitLab, Bitbucket, Bioconductor Download install R packages stored GitHub, GitLab, Bitbucket, Bioconductor, plain subversion git repositories. package lightweight replacement install_* functions devtools. Indeed code copied devtools.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Install packages dependencies. Install GitHub, GitLab, Bitbucket. Install git subversion repositories. Install local files URLs. Install dependencies local package tree. Install specific package versions CRAN. Supports Bioconductor packages. Supports Remotes field DESCRIPTION. See dependencies vignette. Supports Additional_repositories field DESCRIPTION. Can install GitHub (see ). depend R packages. contain compiled code, compiler needed. need external software (functionality least).","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Install released version remotes CRAN:","code":"install.packages(\"remotes\")"},{"path":"https://remotes.r-lib.org/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Note examples use GitHub. See supported repository types. install latest version package default branch GitHub, can use user/repo form. Note user can also organization: R package inside subdirectory root directory, give subdirectory well: install certain branch commit tag, append repo name, @: install latest release, append @*release repo name: install pull request, append # id (integer number) pull request repo name:","code":"remotes::install_github(\"r-lib/conflicted\") # build = FALSE because of some specificities of XGBoost package install_github(\"dmlc/xgboost/R-package\", build = FALSE) remotes::install_github(\"gaborcsardi/pkgconfig@v2.0.0\") remotes::install_github(\"gaborcsardi/pkgconfig@*release\") remotes::install_github(\"r-lib/pkgconfig#7\")"},{"path":"https://remotes.r-lib.org/dev/index.html","id":"dependencies","dir":"","previous_headings":"Usage","what":"Dependencies","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Dependencies automatically installed CRAN. default, outdated dependencies automatically upgraded. interactive sessions can select subset dependencies upgrade.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"dependencies-on-github","dir":"","previous_headings":"Usage > Dependencies","what":"Dependencies on GitHub","title":"R Package Installation from Remote Repositories, Including GitHub","text":"also possible install dependencies GitHub supported repositories. need add Remotes field DESCRIPTION file. format : repo_spec repository specification corresponding install_() function can handle. remote:: missing, github:: assumed. possible values: gitlab::,bitbucket::, git::, local::, svn::, url::, version::, cran::, bioc::. See Remotes field vignette.","code":"Remotes: [remote::]repo_spec, [remote::]repo_spec, ..."},{"path":"https://remotes.r-lib.org/dev/index.html","id":"additional-repositories","dir":"","previous_headings":"Usage > Dependencies","what":"Additional repositories","title":"R Package Installation from Remote Repositories, Including GitHub","text":"remotes supports Additional_repositories field DESCRIPTION. way specify dependencies non-CRAN package repositories. See Writing R extensions manual details.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"bioconductor-packages","dir":"","previous_headings":"Usage > Dependencies","what":"Bioconductor packages","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Bioconductor packages automatically detected dependencies installed Bioconductor.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"currently-supported-remote-types","dir":"","previous_headings":"Usage > Dependencies","what":"Currently supported remote types","title":"R Package Installation from Remote Repositories, Including GitHub","text":"GitHub repositories via install_github. Bitbucket repositories via install_bitbucket. Generic git repositories via install_git. need either system git installation, git2r R package. Local directories package archive files via install_local. Remote package archive files via install_url. Packages subversion repositories via install_svn. need system subversion installation. Specific package versions CRAN CRAN-like repositories via install_version. includes outdated archived packages well. dependencies package local directory via install_deps.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"download-methods","dir":"","previous_headings":"Usage","what":"Download methods","title":"R Package Installation from Remote Repositories, Including GitHub","text":"R older 3.2, curl package required remotes falls back curl::curl_download case R newer 3.3, default download.file() method used. (method = \"auto\") method = \"wininet\" used windows OS method = \"libcurl\" used OS, available. See help(\"download.file\") information methods setting proxies needed.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"standalone-mode","dir":"","previous_headings":"Usage","what":"Standalone mode","title":"R Package Installation from Remote Repositories, Including GitHub","text":"remotes use curl, git2r pkgbuild packages installed provide faster implementations aspects install process. However using remotes install update packages (reverse dependencies) using installation may fail (particularly Windows). set environment variable R_REMOTES_STANDALONE=\"true\" (e.g. R Sys.setenv(R_REMOTES_STANDALONE=\"true\")) can force remotes operate standalone mode use internal R implementations. allow successful installation packages.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"options","dir":"","previous_headings":"Usage","what":"Options","title":"R Package Installation from Remote Repositories, Including GitHub","text":"remotes uses following standard R options, see ?options details: download.file.method default download method. See ?download.file. pkgType package type (source binary, see manual) install, download look dependencies . repos locations user’s standard CRAN(-like) repositories. also uses remotes specific options: BioC_git URL default Bioconductor git mirror. BioC_mirror URL Bioconductor mirror. unzip path external unzip program.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"environment-variables","dir":"","previous_headings":"Usage","what":"Environment variables","title":"R Package Installation from Remote Repositories, Including GitHub","text":"BITBUCKET_USER BITBUCKET_PASSWORD environment variables used default Bitbucket user name password, install_bitbucket() GITHUB_PAT environment variable used default GitHub personal access token GitHub API queries. R_BIOC_MIRROR environment variable can used specify alternative Bioconductor mirror. (BioC_mirror option takes precedence .) R_BIOC_VERSION environment variable can used force Bioconductor version. R_REMOTES_UPGRADE environment variable can used set default preferred value upgrade = argument accepted various install_*() functions. example, can set R_REMOTES_UPGRADE=\"always\" upgrade dependent packages without asking user. Setting R_REMOTES_STANDALONE=\"true\" forces remotes work standalone mode avoid loading optional dependencies (curl, git2 pkgbuild currently. See “Standalone mode” . Setting R_REMOTES_NO_ERRORS_FROM_WARNINGS=\"false\" cause warning messages calls install.packages() become errors. Often warning messages caused dependencies failing install.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"R Package Installation from Remote Repositories, Including GitHub","text":"GPL (>= 2) © Ascent Digital Services, Posit Software, PBC","code":""},{"path":"https://remotes.r-lib.org/dev/reference/available_packages.html","id":null,"dir":"Reference","previous_headings":"","what":"Simpler available.packages — available_packages_set","title":"Simpler available.packages — available_packages_set","text":"mostly equivalent utils::available.packages() however also caches full result. Additionally cache can assigned explicitly available_packages_set() reset (cleared) available_packages_reset().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/available_packages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simpler available.packages — available_packages_set","text":"","code":"available_packages_set(repos, type, db) available_packages_reset() available_packages(repos = getOption(\"repos\"), type = getOption(\"pkgType\"))"},{"path":"https://remotes.r-lib.org/dev/reference/available_packages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simpler available.packages — available_packages_set","text":"repos character vector, base URL(s) repositories use. type character string, indicate type packages: see install.packages. type = \"\" use source repository.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":null,"dir":"Reference","previous_headings":"","what":"Tools for Bioconductor repositories — bioc_version","title":"Tools for Bioconductor repositories — bioc_version","text":"bioc_version() returns Bioconductor version current specified R version.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tools for Bioconductor repositories — bioc_version","text":"","code":"bioc_version(r_ver = getRversion()) bioc_install_repos(r_ver = getRversion(), bioc_ver = bioc_version(r_ver))"},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tools for Bioconductor repositories — bioc_version","text":"r_ver R version use. bioc_install_repos() ignored bioc_ver specified. bioc_ver Bioconductor version use. Defaults default one corresponding r_ver.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tools for Bioconductor repositories — bioc_version","text":"bioc_version() returns Bioconductor version, package_version object. bioc_install_repos() returns named character vector URLs Bioconductor repositories, appropriate current specified R version.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Tools for Bioconductor repositories — bioc_version","text":"bioc_install_repos() deduces URLs Bioconductor repositories. functions observe R_BIOC_VERSION environment variable, can set force Bioconductor version. set, r_ver bioc_ver arguments ignored. bioc_install_repos() observes R_BIOC_MIRROR environment variable also BioC_mirror option, can set desired Bioconductor mirror. option takes precedence set. default value https://bioconductor.org.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Tools for Bioconductor repositories — bioc_version","text":"","code":"bioc_version() #> [1] ‘3.17’ bioc_version(\"3.4\") #> [1] ‘3.6’ bioc_install_repos() #> BioCsoft #> \"https://bioconductor.org/packages/3.17/bioc\" #> BioCann #> \"https://bioconductor.org/packages/3.17/data/annotation\" #> BioCexp #> \"https://bioconductor.org/packages/3.17/data/experiment\" #> BioCworkflows #> \"https://bioconductor.org/packages/3.17/workflows\" #> BioCbooks #> \"https://bioconductor.org/packages/3.17/books\""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a file — download","title":"Download a file — download","text":"Uses either curl package R versions older 3.2.0, otherwise wrapper around download.file().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a file — download","text":"","code":"download( path, url, auth_token = NULL, basic_auth = NULL, quiet = TRUE, headers = NULL )"},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a file — download","text":"path Path download . dirname(path) must exist. url URL. auth_token Token token-based authentication NULL. basic_auth List user password basic HTTP authentication, NULL. quiet Passed download.file() curl::curl_download(). headers Named character vector HTTP headers use.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a file — download","text":"path, download successful.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download a file — download","text":"respect download.file.method setting user. set, see download_method() choosing method. Authentication can supplied three ways: setting auth_token. append HTTP Authorization header: Authorization: token {auth_token}. setting basic_auth list elements user password. append proper Authorization: Basic {encoded_password} HTTP header. specifying proper headers directly. auth_token basic_auth specified, error. auth_token basic_auth appended headers, take precedence Authorization header specified directly headers.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a specified version of a CRAN package — download_version","title":"Download a specified version of a CRAN package — download_version","text":"downloads package temporary file, returns name file.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a specified version of a CRAN package — download_version","text":"","code":"download_version( package, version = NULL, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a specified version of a CRAN package — download_version","text":"package Name package install. version Version package install. Can either string giving exact version required, specification format parenthesized expressions used package dependencies. One following formats: exact version required, string, e.g. \"0.1.13\" comparison operator version, e.g. \">= 0.1.12\" Several criteria satisfy, comma-separated string, e.g. \">= 1.12.0, < 1.14\" Several criteria satisfy, elements character vector, e.g. c(\">= 1.12.0\", \"< 1.14\") repos character vector, base URL(s) repositories use, e.g., URL CRAN mirror \"https://cloud.r-project.org\". details supported URL schemes see url. Can NULL install local files, directories URLs: inferred extension pkgs length one. type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a specified version of a CRAN package — download_version","text":"Name downloaded file.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/git_credentials.html","id":null,"dir":"Reference","previous_headings":"","what":"Specify git credentials to use — git_credentials","title":"Specify git credentials to use — git_credentials","text":"global option remotes.git_credentials used set git credentials.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/git_credentials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Specify git credentials to use — git_credentials","text":"","code":"git_credentials()"},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":null,"dir":"Reference","previous_headings":"","what":"GitHub references — github_pull","title":"GitHub references — github_pull","text":"Use ref parameter install_github(). Allows installing specific pull request latest release.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"GitHub references — github_pull","text":"","code":"github_pull(pull) github_release()"},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"GitHub references — github_pull","text":"pull Character string specifying pull request install","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"GitHub references — github_pull","text":"","code":"github_pull(\"42\") #> [1] \"42\" #> attr(,\"class\") #> [1] \"github_pull\""},{"path":"https://remotes.r-lib.org/dev/reference/github_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a new github_remote — github_remote","title":"Create a new github_remote — github_remote","text":"internal function create new github_remote, users generally need .","code":""},{"path":"https://remotes.r-lib.org/dev/reference/github_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a new github_remote — github_remote","text":"","code":"github_remote( repo, ref = \"HEAD\", subdir = NULL, auth_token = github_pat(), sha = NULL, host = \"api.github.com\", ... )"},{"path":"https://remotes.r-lib.org/dev/reference/github_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a new github_remote — github_remote","text":"repo Repository address format username/repo[/subdir][@ref|#pull|@*release]. Alternatively, can specify subdir /ref using respective parameters (see ); specified, values repo take precedence. ref Desired git reference. commit, tag, branch name, call github_pull() github_release(). Defaults \"HEAD\", means default branch GitHub git remotes. See setting--default-branch details. subdir Subdirectory within repo contains R package. auth_token install private repo, generate personal access token (PAT) least repo scope https://github.com/settings/tokens supply argument. safer using password can easily delete PAT without affecting others. Defaults GITHUB_PAT environment variable. host GitHub API host use. Override GitHub enterprise hostname, example, \"github.hostname.com/api/v3\". ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/gitlab_pat.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve GitLab personal access token. — gitlab_pat","title":"Retrieve GitLab personal access token. — gitlab_pat","text":"GitLab personal access token Looks env var GITLAB_PAT","code":""},{"path":"https://remotes.r-lib.org/dev/reference/gitlab_pat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve GitLab personal access token. — gitlab_pat","text":"","code":"gitlab_pat(quiet = TRUE)"},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a development package from the Bioconductor git repository — install_bioc","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"function requires git installed system order used.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"","code":"install_bioc( repo, mirror = getOption(\"BioC_git\", download_url(\"git.bioconductor.org/packages\")), git = c(\"auto\", \"git2r\", \"external\"), dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"repo Repository address format [username:password@][release/]repo[#commit]. Valid values release ‘devel’, ‘release’ (default none specified), numeric release numbers (e.g. ‘3.3’). mirror Bioconductor git mirror use git Whether use git2r package, external git client via system. Default git2r installed, otherwise external git installation. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"vectorised can install multiple packages single command. intended aid Bioconductor developers. want install release version Bioconductor package one can use BiocManager package.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"","code":"if (FALSE) { install_bioc(\"SummarizedExperiment\") install_bioc(\"devel/SummarizedExperiment\") install_bioc(\"3.3/SummarizedExperiment\") install_bioc(\"SummarizedExperiment#abc123\") install_bioc(\"user:password@release/SummarizedExperiment\") install_bioc(\"user:password@devel/SummarizedExperiment\") install_bioc(\"user:password@SummarizedExperiment#abc123\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package directly from Bitbucket — install_bitbucket","title":"Install a package directly from Bitbucket — install_bitbucket","text":"function vectorised can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package directly from Bitbucket — install_bitbucket","text":"","code":"install_bitbucket( repo, ref = \"HEAD\", subdir = NULL, auth_user = bitbucket_user(), password = bitbucket_password(), host = \"api.bitbucket.org/2.0\", dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package directly from Bitbucket — install_bitbucket","text":"repo Repository address format username/repo[/subdir][@ref]. Alternatively, can specify subdir /ref using respective parameters (see ); specified, values repo take precedence. ref Desired git reference; commit, tag, branch name. Defaults HEAD. subdir Subdirectory within repo contains R package. auth_user account username attempting install package hosted private repository (username different username). Defaults BITBUCKET_USER environment variable. password password. Defaults BITBUCKET_PASSWORD environment variable. See details information setting password. host GitHub API host use. Override GitHub enterprise hostname, example, \"github.hostname.com/api/v3\". dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a package directly from Bitbucket — install_bitbucket","text":"install private repo, generally, access Bitbucket API credentials, need get access token. can create access token following instructions found Bitbucket App Passwords documentation. App Password requires read-access repositories pull requests. store password environment variable BITBUCKET_PASSWORD (e.g. evelynwaugh:swordofhonour) Note Windows, authentication requires \"libcurl\" download method. can set default download method via download.file.method option: particular, unset, RStudio sets download method \"wininet\". override , might want set \"libcurl\" R profile, see base::Startup. caveat \"libcurl\" method set system proxies automatically, see \"Setting Proxies\" utils::download.file().","code":"options(download.file.method = \"libcurl\")"},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package directly from Bitbucket — install_bitbucket","text":"","code":"if (FALSE) { install_bitbucket(\"sulab/mygene.r@default\") install_bitbucket(\"djnavarro/lsr\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":null,"dir":"Reference","previous_headings":"","what":"Attempts to install a package from CRAN. — install_cran","title":"Attempts to install a package from CRAN. — install_cran","text":"function vectorised pkgs can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attempts to install a package from CRAN. — install_cran","text":"","code":"install_cran( pkgs, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attempts to install a package from CRAN. — install_cran","text":"pkgs character vector packages install. repos character vector giving repositories use. type Type package update. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attempts to install a package from CRAN. — install_cran","text":"","code":"if (FALSE) { install_cran(\"ggplot2\") install_cran(c(\"httpuv\", \"shiny\")) }"},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Install package dependencies if needed. — install_deps","title":"Install package dependencies if needed. — install_deps","text":"Install package dependencies needed.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install package dependencies if needed. — install_deps","text":"","code":"install_deps( pkgdir = \".\", dependencies = NA, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), upgrade = c(\"default\", \"ask\", \"always\", \"never\"), quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install package dependencies if needed. — install_deps","text":"pkgdir Path package directory, package tarball. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. repos character vector giving repositories use. type Type package update. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). ... additional arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install package dependencies if needed. — install_deps","text":"","code":"if (FALSE) install_deps(\".\")"},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":null,"dir":"Reference","previous_headings":"","what":"Install the development version of a package — install_dev","title":"Install the development version of a package — install_dev","text":"install_dev() retrieves package DESCRIPTION CRAN mirror looks 'URL' 'BugReports' fields GitHub, GitLab Bitbucket URLs. calls appropriate install_() function install development package.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install the development version of a package — install_dev","text":"","code":"install_dev(package, cran_url = getOption(\"repos\")[[\"CRAN\"]], ...)"},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install the development version of a package — install_dev","text":"package package name install. cran_url URL CRAN mirror use, default based 'repos' option. unset uses 'https://cloud.r-project.org'. ... Additional arguments passed install_github(), install_gitlab(), install_bitbucket() functions.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install the development version of a package — install_dev","text":"","code":"if (FALSE) { # From GitHub install_dev(\"dplyr\") # From GitLab install_dev(\"iemiscdata\") # From Bitbucket install_dev(\"argparser\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a git repository — install_git","title":"Install a package from a git repository — install_git","text":"vectorised can install multiple packages single command. need git2r package, external git client installed.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a git repository — install_git","text":"","code":"install_git( url, subdir = NULL, ref = NULL, branch = NULL, credentials = git_credentials(), git = c(\"auto\", \"git2r\", \"external\"), dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a git repository — install_git","text":"url Location package. url point public private repository. subdir sub-directory within git repository may contain package interested installing. ref Name branch, tag SHA reference use, HEAD. branch Deprecated, synonym ref. credentials git2r credentials object passed clone. Supplying argument implies using git2r git. git Whether use git2r package, external git client via system. Default git2r installed, otherwise external git installation. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a package from a git repository — install_git","text":"need set git credentials use Remotes field can placing credentials remotes.git_credentials global option.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a git repository — install_git","text":"","code":"if (FALSE) { install_git(\"https://github.com/hadley/stringr.git\") install_git(\"https://github.com/hadley/stringr.git\", ref = \"stringr-0.2\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":null,"dir":"Reference","previous_headings":"","what":"Attempts to install a package directly from GitHub. — install_github","title":"Attempts to install a package directly from GitHub. — install_github","text":"function vectorised repo can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attempts to install a package directly from GitHub. — install_github","text":"","code":"install_github( repo, ref = \"HEAD\", subdir = NULL, auth_token = github_pat(quiet), host = \"api.github.com\", dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attempts to install a package directly from GitHub. — install_github","text":"repo Repository address format username/repo[/subdir][@ref|#pull|@*release]. Alternatively, can specify subdir /ref using respective parameters (see ); specified, values repo take precedence. ref Desired git reference. commit, tag, branch name, call github_pull() github_release(). Defaults \"HEAD\", means default branch GitHub git remotes. See setting--default-branch details. subdir Subdirectory within repo contains R package. auth_token install private repo, generate personal access token (PAT) least repo scope https://github.com/settings/tokens supply argument. safer using password can easily delete PAT without affecting others. Defaults GITHUB_PAT environment variable. host GitHub API host use. Override GitHub enterprise hostname, example, \"github.hostname.com/api/v3\". dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Attempts to install a package directly from GitHub. — install_github","text":"repository uses submodules command-line git client required clone submodules.","code":""},{"path":[]},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from GitLab — install_gitlab","title":"Install a package from GitLab — install_gitlab","text":"function vectorised repo can install multiple packages single command. Like remotes repository skip installation force == FALSE (default) remote state changed since previous installation.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from GitLab — install_gitlab","text":"","code":"install_gitlab( repo, subdir = NULL, auth_token = gitlab_pat(quiet), host = \"gitlab.com\", dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from GitLab — install_gitlab","text":"repo Repository address format username/repo[@ref]. subdir Subdirectory within repo contains R package. auth_token install private repo, generate personal access token (PAT) least read_api scope https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html supply argument. safer using password can easily delete PAT without affecting others. Defaults GITLAB_PAT environment variable. host GitLab API host use. Override GitLab enterprise hostname, example, \"gitlab.hostname.com\". PROTOCOL required packrat Posit Connect deployment. install_gitlab may work without, omitting generally leads package restoration errors. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from GitLab — install_gitlab","text":"","code":"if (FALSE) { install_gitlab(\"jimhester/covr\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a local file — install_local","title":"Install a package from a local file — install_local","text":"function vectorised can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a local file — install_local","text":"","code":"install_local( path = \".\", subdir = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = !is_binary_pkg(path), build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a local file — install_local","text":"path path local directory, compressed file (tar, zip, tar.gz tar.bz2, tgz2 tbz) subdir subdirectory within url bundle contains R package. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a local file — install_local","text":"","code":"if (FALSE) { dir <- tempfile() dir.create(dir) pkg <- download.packages(\"testthat\", dir, type = \"source\") install_local(pkg[, 2]) }"},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a remote package. — install_remote","title":"Install a remote package. — install_remote","text":": downloads source bundle decompresses & checks package adds metadata DESCRIPTION calls install","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a remote package. — install_remote","text":"","code":"install_remote( remote, dependencies, upgrade, force, quiet, build, build_opts, build_manual, build_vignettes, repos, type, ... ) add_metadata(pkg_path, meta) remote_download(x, quiet = FALSE) remote_metadata(x, bundle = NULL, source = NULL, sha = NULL) remote_package_name(remote, ...) remote_sha(remote, ...)"},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a remote package. — install_remote","text":"dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a remote package. — install_remote","text":"uses additional S3 generic functions work. Writing methods functions allow 3rd party packages define custom remotes.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a SVN repository — install_svn","title":"Install a package from a SVN repository — install_svn","text":"function requires svn installed system order used.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a SVN repository — install_svn","text":"","code":"install_svn( url, subdir = NULL, args = character(0), revision = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a SVN repository — install_svn","text":"url Location package. url point public private repository. subdir sub-directory within svn repository contains package interested installing. args character vector providing extra options pass svn. revision svn revision, omitted updates latest dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a package from a SVN repository — install_svn","text":"vectorised can install multiple packages single command.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a SVN repository — install_svn","text":"","code":"if (FALSE) { install_svn(\"https://github.com/hadley/stringr/trunk\") install_svn(\"https://github.com/hadley/httr/branches/oauth\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a url — install_url","title":"Install a package from a url — install_url","text":"function vectorised can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a url — install_url","text":"","code":"install_url( url, subdir = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a url — install_url","text":"url location package internet. url point zip file, tar file bzipped/gzipped tar file. subdir subdirectory within url bundle contains R package. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a url — install_url","text":"","code":"if (FALSE) { install_url(\"https://github.com/hadley/stringr/archive/HEAD.zip\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Install specific version of a package. — install_version","title":"Install specific version of a package. — install_version","text":"function knows look multiple CRAN-like package repositories, archive directories, order find specific versions requested package.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install specific version of a package. — install_version","text":"","code":"install_version( package, version = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = FALSE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = \"source\", ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install specific version of a package. — install_version","text":"package Name package install. version Version package install. Can either string giving exact version required, specification format parenthesized expressions used package dependencies. One following formats: exact version required, string, e.g. \"0.1.13\" comparison operator version, e.g. \">= 0.1.12\" Several criteria satisfy, comma-separated string, e.g. \">= 1.12.0, < 1.14\" Several criteria satisfy, elements character vector, e.g. c(\">= 1.12.0\", \"< 1.14\") dependencies logical indicating whether also install uninstalled packages packages depend /link /import/suggest (recursively). used repos = NULL. Can also character vector, subset c(\"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"). supported lib length one (missing), unambiguous install dependent packages. case ignored, warning. default, NA, means c(\"Depends\", \"Imports\", \"LinkingTo\"). TRUE means use c(\"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\") pkgs c(\"Depends\", \"Imports\", \"LinkingTo\") added dependencies: installs packages needed run pkgs, examples, tests vignettes (package author specified correctly). , \"LinkingTo\" omitted binary packages. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet logical: true, reduce amount output. passed available.packages() case called, purpose. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector, base URL(s) repositories use, e.g., URL CRAN mirror \"https://cloud.r-project.org\". details supported URL schemes see url. Can NULL install local files, directories URLs: inferred extension pkgs length one. type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install specific version of a package. — install_version","text":"repositories searched order specified repos argument. enables teams maintain multiple -house repositories different policies - instance, one repo development snapshots one official releases. common setup first search official release repo, dev snapshot repo, public CRAN mirror. Older versions packages CRAN usually available source form. requested package contains compiled code, need R development environment installed. can check running devtools::has_devel (need devtools package ).","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install specific version of a package. — install_version","text":"","code":"if (FALSE) { install_version(\"devtools\", \"1.11.0\") install_version(\"devtools\", \">= 1.12.0, < 1.14\") ## Specify search order (e.g. in ~/.Rprofile) options(repos = c( prod = \"http://mycompany.example.com/r-repo\", dev = \"http://mycompany.example.com/r-repo-dev\", CRAN = \"https://cran.revolutionanalytics.com\" )) install_version(\"mypackage\", \"1.15\") # finds in 'prod' install_version(\"mypackage\", \"1.16-39487\") # finds in 'dev' }"},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Find all dependencies of a CRAN or dev package. — package_deps","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"Find dependencies package determine whether ahead behind CRAN. print() method identifies mismatches () local CRAN versions dependent package; update() method installs outdated missing packages CRAN.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"","code":"package_deps( packages, dependencies = NA, repos = getOption(\"repos\"), type = getOption(\"pkgType\") ) local_package_deps(pkgdir = \".\", dependencies = NA) dev_package_deps( pkgdir = \".\", dependencies = NA, repos = getOption(\"repos\"), type = getOption(\"pkgType\") ) # S3 method for package_deps update( object, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"packages character vector package names. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. repos character vector giving repositories use. type Type package update. pkgdir Path package directory, package tarball. object package_deps object. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). ... Additional arguments passed install_packages.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"data.frame columns:","code":""},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"","code":"if (FALSE) { package_deps(\"devtools\") # Use update to update any out-of-date dependencies update(package_deps(\"devtools\")) }"},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a remote git repo specification — parse-git-repo","title":"Parse a remote git repo specification — parse-git-repo","text":"remote repo can specified two ways: URL parse_github_url() handles HTTPS SSH remote URLs various GitHub browser URLs via shorthand parse_repo_spec() handles concise form: [username/]repo[/subdir][#pull|@ref|@*release]","code":""},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a remote git repo specification — parse-git-repo","text":"","code":"parse_repo_spec(repo) parse_github_repo_spec(repo) parse_github_url(repo)"},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse a remote git repo specification — parse-git-repo","text":"repo Character scalar, repo specification.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse a remote git repo specification — parse-git-repo","text":"List members: username, repo, subdir ref, pull, release, empty.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse a remote git repo specification — parse-git-repo","text":"","code":"parse_repo_spec(\"metacran/crandb\") #> $package #> [1] \"\" #> #> $username #> [1] \"metacran\" #> #> $repo #> [1] \"crandb\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"jimhester/covr#47\") ## pull request #> $package #> [1] \"\" #> #> $username #> [1] \"jimhester\" #> #> $repo #> [1] \"covr\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"47\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"jeroen/curl@v0.9.3\") ## specific tag #> $package #> [1] \"\" #> #> $username #> [1] \"jeroen\" #> #> $repo #> [1] \"curl\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"v0.9.3\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"tidyverse/dplyr@*release\") ## shorthand for latest release #> $package #> [1] \"\" #> #> $username #> [1] \"tidyverse\" #> #> $repo #> [1] \"dplyr\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"*release\" #> parse_repo_spec(\"r-lib/remotes@550a3c7d3f9e1493a2ba\") ## commit SHA #> $package #> [1] \"\" #> #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"550a3c7d3f9e1493a2ba\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"igraph=igraph/rigraph\") ## Different package name from repo name #> $package #> [1] \"igraph\" #> #> $username #> [1] \"igraph\" #> #> $repo #> [1] \"rigraph\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/jeroen/curl.git\") #> $username #> [1] \"jeroen\" #> #> $repo #> [1] \"curl\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"git@github.com:metacran/crandb.git\") #> $username #> [1] \"metacran\" #> #> $repo #> [1] \"crandb\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/jimhester/covr\") #> $username #> [1] \"jimhester\" #> #> $repo #> [1] \"covr\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.example.com/user/repo.git\") #> $username #> [1] \"user\" #> #> $repo #> [1] \"repo\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"git@github.example.com:user/repo.git\") #> $username #> [1] \"user\" #> #> $repo #> [1] \"repo\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/pull/108\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"108\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/tree/name-of-branch\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"name-of-branch\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/commit/1234567\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"1234567\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/releases/latest\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"*release\" #> parse_github_url(\"https://github.com/r-lib/remotes/releases/tag/1.0.0\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"1.0.0\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #>"},{"path":"https://remotes.r-lib.org/dev/reference/remotes-package.html","id":null,"dir":"Reference","previous_headings":"","what":"remotes: R Package Installation from Remote Repositories, Including 'GitHub' — remotes-package","title":"remotes: R Package Installation from Remote Repositories, Including 'GitHub' — remotes-package","text":"Download install R packages stored 'GitHub', 'GitLab', 'Bitbucket', 'Bioconductor', plain 'subversion' 'git' repositories. package provides 'install_*' functions 'devtools'. Indeed code copied 'devtools'.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/remotes-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"remotes: R Package Installation from Remote Repositories, Including 'GitHub' — remotes-package","text":"Maintainer: Gábor Csárdi csardi.gabor@gmail.com Authors: Jim Hester Hadley Wickham Winston Chang Martin Morgan Dan Tenenbaum contributors: Posit Software, PBC [copyright holder, funder] Ascent Digital Services [copyright holder]","code":""},{"path":"https://remotes.r-lib.org/dev/reference/standardise_dep.html","id":null,"dir":"Reference","previous_headings":"","what":"Standardise dependencies using the same logical as install.packages — standardise_dep","title":"Standardise dependencies using the same logical as install.packages — standardise_dep","text":"Standardise dependencies using logical install.packages","code":""},{"path":"https://remotes.r-lib.org/dev/reference/standardise_dep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standardise dependencies using the same logical as install.packages — standardise_dep","text":"","code":"standardise_dep(x)"},{"path":"https://remotes.r-lib.org/dev/reference/standardise_dep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standardise dependencies using the same logical as install.packages — standardise_dep","text":"x dependencies standardise. character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies. value \"soft\" means TRUE, \"hard\" means NA. additional values match one standard dependency types filtered .","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":null,"dir":"Reference","previous_headings":"","what":"Query the system requirements for a package (and its dependencies) — system_requirements","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"Returns character vector commands run install system requirements queried operating system.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"","code":"system_requirements( os, os_release = NULL, path = \".\", package = NULL, curl = Sys.which(\"curl\") )"},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"os, os_release operating system operating system release version, see https://github.com/rstudio/r-system-requirements#operating-systems list supported operating systems. os_release NULL, os must consist operating system version separated dash, e.g. \"ubuntu-18.04\". path path dev package's root directory. package CRAN package name(s) lookup system requirements . NULL, used path ignored. curl location curl binary system.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"character vector commands needed install system requirements package.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":null,"dir":"Reference","previous_headings":"","what":"Update packages that are missing or out-of-date. — update_packages","title":"Update packages that are missing or out-of-date. — update_packages","text":"Works similarly utils::install.packages() install packages already installed, also upgrades dated dependencies.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update packages that are missing or out-of-date. — update_packages","text":"","code":"update_packages( packages = TRUE, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update packages that are missing or out-of-date. — update_packages","text":"packages Character vector packages update. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Deprecated, argument effect. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update packages that are missing or out-of-date. — update_packages","text":"","code":"if (FALSE) { update_packages(\"ggplot2\") update_packages(c(\"plyr\", \"ggplot2\")) }"},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-242","dir":"Changelog","previous_headings":"","what":"remotes 2.4.2","title":"remotes 2.4.2","text":"CRAN release: 2021-11-30 Gábor Csárdi now maintainer. bioc_version() now points recent (2021-10-27) Bioconductor release, v3.14 (@stufield, #664). Fix regex handle user names URL git_remote, add regression tests (@achimgaedke, #646).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-241","dir":"Changelog","previous_headings":"","what":"remotes 2.4.1","title":"remotes 2.4.1","text":"CRAN release: 2021-09-29 pkgbuild longer accidentally loaded even standalone mode (#548) internal GitHub token used increase rate limits regenerated. Using remote_package_name.git2r_remote now passes credentials looking package DESCRIPTION (#633, @rnorberg) Using remote_package_name.git2r_remote remote_package_name.xgit_remote, http responses returning invalid DESCRIPTION redirect another page now fallback return NA instead throwing error trying parse unexpected content (#628, @dgkf). Fix regex breaks git protocol git_remote (@niheaven #630). Clarify github_pull() documentation (@ms609 #640).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-240","dir":"Changelog","previous_headings":"","what":"remotes 2.4.0","title":"remotes 2.4.0","text":"CRAN release: 2021-06-02 Re-license MIT. (#551) Fix bug install_bioc() using version=‘devel’. code now pull git HEAD, branch named ‘HEAD’ (@bbimber, #612). skip tests download.file(method = \"internal\"), R > 4.1, since method now defunct versions. system_requirements() now works intended os argument used (@mdneuzerling, #609) remote_package_name.git2r_remote remote_package_name.xgit_remote now get correct package name HTTP(S) git repo’s DESCRIPTION file, thus package’s DESCRIPTION file’s Remotes field git::http(s):////[.git][@ref] items install remote packages using git via HTTP(S) protocol (@niheaven, #603).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-230","dir":"Changelog","previous_headings":"","what":"remotes 2.3.0","title":"remotes 2.3.0","text":"CRAN release: 2021-04-01","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"major-changes-2-3-0","dir":"Changelog","previous_headings":"","what":"Major changes","title":"remotes 2.3.0","text":"install_*() functions longer fail default warnings install.packages(). Concretely default value R_REMOTES_NO_ERRORS_FROM_WARNINGS changed true previous value false. (#403)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-3-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.3.0","text":"install_bioc() now respects environment variable R_BIOC_VERSION, use git branch corresponding Bioconductor version (@bbimber, #580). remotes without package names now unconditionally installed (#532, @jakubkovac) now possible specify custom host dependencies listed DESCRIPTION file Remotes: [@host]::/[@ref]. ref now supports / GitLab repositories GitHubrepositories. (@dagola, #448) Internal package2remote() function now supports local remotes created pak. github_pat() now check GITHUB_TOKEN set find GITHUB_PAT. (@coatless) system_requirements() now supports querying released packages well development dependencies (#545) system_requirements() now supports OS name + version os argument (#549, @krlmlr).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-220","dir":"Changelog","previous_headings":"","what":"remotes 2.2.0","title":"remotes 2.2.0","text":"CRAN release: 2020-07-21","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"new-functions-and-features-2-2-0","dir":"Changelog","previous_headings":"","what":"New functions and features","title":"remotes 2.2.0","text":"New system_requirements() function query Public RStudio Package Manager system requirements package (dependencies) Remotes functions can now install dependencies additional DESCRIPTION fields, e.g. passing dependencies = \"Config/Needs/website\" install dependencies listed Config/Needs/website: field package’s DESCRIPTION. Prefixing fields Config/Needs allows pass R CMD check without NOTE, recommended format extra dependencies. install_*() family functions now use default branch repository, master branch (@MyKo101,#508).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-2-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.2.0","text":"Internal functions remote_download(), remote_metadata(), remote_package_name() remote_sha() now exported, 3rd party packages provide methods new remote types (#509, #56) Internal functions add_metadata(), github_remote() now exported. mainly 3rd party extensions used users (#485). install_version() now keeps searching subsequent repositories requested version, rather failing version finds early repository unsuitable. (#305, @kenahoo) install_version() now understands specifications like ‘>= 1.0’ ‘>= 1.12.0, < 1.14’ install first version package can find satisfies criteria. (#305, @kenahoo) install_version() now avoids use base::url(), prior R 3.6.2 bug downloading large files (#463) parse_submodules() internal regular expression now PCRE 2 compatible (#502, @jan-glx) update_packages() argument force deprecated longer effect (#521) Another fix mixed binary source dependency issue, hopefully fully squashed now (#296) upgrade menu now interruptible RStudio (#489). Internal GitHub functions now correctly handle cases characters representable default locale, representable UTF-8 (#492).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-211","dir":"Changelog","previous_headings":"","what":"remotes 2.1.1","title":"remotes 2.1.1","text":"CRAN release: 2020-02-15","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-1-1","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.1.1","text":"Installing mixed binary source dependencies latest versions packages binaries yet now install dependencies correct order prevent load failures (#296) github_error() now also works GitHub (Enterprise) server return information rate limit (@dpprdan, #396, #413). install_gitlab passes quiet argument gitlab_pat (@michaelchirico, #437) remotes now resilient installed packages declare RemoteType: standard include RemoteRepos RemotePkgType field. case, values getOption(\"repos\") getOption(\"pkgType\") used (respectively). install_gitlab() now installs repositories subgroups dots name. subdir now explicit argument instead implicit repo (@robertdj, #259, #420). install() now passes ellipsis ... install_deps() (@Neil-Schneider, #411) tests updated work newer versions callr R 4.0","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-210","dir":"Changelog","previous_headings":"","what":"remotes 2.1.0","title":"remotes 2.1.0","text":"CRAN release: 2019-06-24","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"new-features-2-1-0","dir":"Changelog","previous_headings":"","what":"New features","title":"remotes 2.1.0","text":"install_*() functions gain build_manual build_vignette arguments previously existed devtools versions < 2.0 (#353). interactive menu modified provide clear instructions skipping behavior (#207) Credentials now passed via HTTP headers, reduce exposure requests fail (#391).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-1-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.1.0","text":"download() external curl download method now always uses -L follow redirects. (#350) update_packages() now informative error message update fails (#223, #232) install_git() now can take credentials global option remotes.git_credentials (#378). install_git() now works SHA references external git (#389). GitHub remotes point branches longer fail branch later deleted (#274). Local remotes whose original location moved longer error updating (#370). update_deps() longer sorts dependencies alphabetically (#296, #301) github_resolve_ref() now takes host parameter (#284) Remotes specific environment variables now accept 0 1 valid values (#238) remotes now uses locking default installing binary packages, avoids issues installing binaries already open R processes (#368) update_deps() longer fails local package longer exists (#289) install_version() now errors informative message type ‘source’ (#323) Bioc remote_sha() now always returns character result (#379) Fix API call private repositories install_gitlab (@aornugent, #359, #363) git submodules now work submodule file empty (@muschellij2, #234) git submodules now work R package stored subfolder (@pommedeterresautee, #233) install_gitlab() longer adds access token twice request (@aornugent, #363). Bitbucket dependencies now actually use BITBUCKET_USER BITBUCKET_PASSWORD environment variables (@antoine-sachet, #347). parse_deps() now ignores trailing whitespaces around comparison operators DESCRIPTION fields (@LiNk-NY, #366)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-204","dir":"Changelog","previous_headings":"","what":"remotes 2.0.4","title":"remotes 2.0.4","text":"CRAN release: 2019-04-10 update.package_dependencies() now uses pkg_type cran remote rather global type attribute, fixing errors global attribute lost (#291, #304). Credentials longer passed dependencies, breaks dependencies use different credentials hosts. relied behavior robust way provide credentials using appropriate environment variables, e.g. GITHUB_PAT, BITBUCKET_USER etc. (@antoine-sachet, #345). hash bitbucket hosts now correctly retrieved (@antoine-sachet, #344) Fix parsing Additional_Repositories leading newline (@tmelliott, #251).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-203","dir":"Changelog","previous_headings":"","what":"remotes 2.0.3","title":"remotes 2.0.3","text":"CRAN release: 2019-04-09 order choices upgrade = \"ask\" now puts stable ones ‘’, ‘CRAN ’, ‘none’ first, always numbers (#287). update_submodules() now works empty .gitmodules files (@jsilve24, #329). remotes now understands “standard” remote type, produced packages installed CRAN using pak (#309) install_dev() now supports ref/pull format, e.g. install_dev('shiny@v1.2-rc') (@mkearney, #279). Fix return type install_remote() circular dependency (#225) remote_package_name.github_remote() now works properly Windows (#248) install_bioc() repositories now updated Bioconductor 3.8 release. (#239) install_* functions now set R_LIBS* environment variables child processes correctly Windows (@HenrikBengtsson, #253) install_* functions now support R_REMOTES_UPGRADE environment variable, set default upgrade argument. See README details (@kevinushey, #240). install_* functions perform basic HTTP authentication using HTTP headers now. fixes issue install_bitbucket() private repos (#255). install_* functions now respect download.file.method option, download_file() used HTTP. install_* functions now use libcurl method, download.file.method option set different one, libcurl available. , wininet method preferred Windows. rely proxy configuration wininet, might want set download.file.method option, use another way set proxies, see ?download.file. Remotes without package names now unconditionally installed (#246). install_github() now includes informative error message status code 404, asking user check spelled repo owner repo correctly (included error message), required permissions access repository. install_* functions (via underlying private install function) now set RGL_USE_NULL=\"TRUE\" order avoid errors running headless installing package using rgl (@jefferis, ##333)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-202","dir":"Changelog","previous_headings":"","what":"remotes 2.0.2","title":"remotes 2.0.2","text":"CRAN release: 2018-10-30 install_deps() now installs un-installed remotes packages even upgrade = \"never\" (@ankane, #227) install_version() now removes metadata added byproduct using install_url() internally() (#224) install() now avoids converting warnings errors R_REMOTES_NO_ERRORS_FROM_WARNINGS unset _R_CHECK_FORCE_SUGGESTS_=false. avoids failures due Suggested packages potentially missing. install_bitbucket() now works properly packages subdirectories (#220) install_deps() now installs un-installed packages even upgrade = \"never\" (#218)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-201","dir":"Changelog","previous_headings":"","what":"remotes 2.0.1","title":"remotes 2.0.1","text":"CRAN release: 2018-10-19 install_github() now bundles GitHub PAT used Travis avoid hitting rate limit frequently. also contains informative error message rate limit hit setup GitHub personal access token. dialog upgrade = \"ask\" now ‘CRAN ’ option, update CRAN packages. longer include project specific .Rprofile code temporary .Rprofile R_REMOTES_NO_ERRORS_FROM_WARNINGS=false (default). update.package_deps() longer prompts install uninstalled dependencies, always installed (#203). available_packages(), available_packages_set() available_packges_reset() added allow caching available.packages() database.","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-200","dir":"Changelog","previous_headings":"","what":"remotes 2.0.0","title":"remotes 2.0.0","text":"CRAN release: 2018-10-11","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"breaking-changes-2-0-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"remotes 2.0.0","text":"install_github()’s previously deprecated username argument removed. (#142) install_deps()’s threads argument removed, use Ncpus argument instead (#153, #154) install_git()’s branch argument renamed ref branch deprecated.","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"new-features-2-0-0","dir":"Changelog","previous_headings":"","what":"New features","title":"remotes 2.0.0","text":"remotes now builds packages default installing . step uses pkgbuild package, available. , calls R CMD build directly. New install_dev() install development version CRAN package, based URL BugReports fields DESCRIPTION file (#144). install_()* functions now temporally put Rtools PATH necessary, long pkgbuild package installed. remotes can forced use internal code setting environment variable R_REMOTES_STANDALONE = “true”. useful installing optional dependencies remotes Windows, curl git2r (#147) installing, remotes now errors warnings, catch cases packages partially installed. often happens windows package dll opened another R process (#113). install_() functions now pass arguments, including authentication information upgrade dependencies (#53, #86, #87). install_() functions allow selection subset packages upgrade, interactive mode, upgrade = \"ask\". install_git() now supports passing credentials, used git = \"git2r\" (#106) install_() functions now return name package(s) installed (#55). git submodules now installed exist git client available (#138, #133, #103, #82). New install_gitlab() install_bioc() functions, install gitlab bioc remote types. remotes now uses SHA updating logic remotes devtools, including checking SHA remote changed since last installation. (#135) install_url() can now install package binaries windows (r-lib/devtools#1765)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-0-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.0.0","text":"install_deps() et al. now rewrite type argument binary allow falling back source. fixes various installation failures. remotes now looks GitHub package names locally, possible, uses GitHub REST API (curl package available, standalone mode). makes remote lookup 10x faster remote package changed since last install. Using GITHUB_PAT longer prints diagnostic messages default (r-lib/devtools#1752). remotes now always uses https URLs R versions support (@ankane, #139) include BioCextra repository versions deprecated (R 3.5+, Bioc 3.6+). install_() functions now download tarballs (.tar.gz) files rather zip archives (.zip). results generally smaller files avoids issues script permissions lost strange behavior external unzip programs Windows (#96). Dependency parsing now robust whitespace around dependency specifications (#73). standardise_dep() exported, use devtools. install_local() now defaults current directory. install_bitbucket() now correctly supports authentication, subdir argument. install_() functions give helpful warning package long path names, Windows. case building package usually fails. (#84, #178). install_() functions now robust way handling various tar programs Windows (#172). install_() functions now give helpful warning older R versions, Windows, R.home() contains space character. Installation usually fails case. GitHub API errors now give better error messages, including data API rate limits.","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-111","dir":"Changelog","previous_headings":"","what":"remotes 1.1.1","title":"remotes 1.1.1","text":"CRAN release: 2017-12-20 Accept HTTPS, SSH, various browser URLs GitHub repo specification, @jennybc, #90, #109, #112","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-110","dir":"Changelog","previous_headings":"","what":"remotes 1.1.0","title":"remotes 1.1.0","text":"CRAN release: 2017-07-09 URL encode GitHub references, allow installing non-alphanumeric branch tags, @krlmlr #38 Better cooperation proxy servers, better download method selection Windows, @cderv, #45, #46 install_deps() supports tar balls, #47 Allow training slash GitHub repo specification, #54 Work around Linux systems, unzip set empty string, @HenrikBengtsson, #57 Check circular dependencies installing, #31 Updated Bioconductor repo URLs newer BioC versions","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-100","dir":"Changelog","previous_headings":"","what":"remotes 1.0.0","title":"remotes 1.0.0","text":"CRAN release: 2016-09-10 First public release.","code":""}] +[{"path":[]},{"path":"https://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.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://remotes.r-lib.org/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2021 remotes 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://remotes.r-lib.org/dev/MAINTENANCE.html","id":"current-state","dir":"","previous_headings":"","what":"Current state","title":"NA","text":"Remotes mostly stable works vast majority people. However accumulates steady stream issues pull requests. Many issues general installation problems unrelated remotes , often better addressed community site. pull requests extensions code hosting platforms, tweaks ones don’t use regularly (like GitLab). makes somewhat challenging review accept, platform don’t typically use easy things break future. addition testing general challenge, many tests require internet access use hourly rate limits, makes flaky test suite pretty slow overall. also Makefile needs run code change, easy forget practice.","code":""},{"path":"https://remotes.r-lib.org/dev/MAINTENANCE.html","id":"known-outstanding-issues","dir":"","previous_headings":"","what":"Known outstanding issues","title":"NA","text":"remotes contains bundled PAT make using remotes CI services avoid rate limits. Unfortunately bundled PAT somewhat frequently gets invalidated user commits somewhere GitHub GitHub automatically scans new commits PATs invalidates . happens release new version remotes new PAT. damage done somewhat limited days, GitHub Actions workflows default use automatic GITHUB_TOKEN PAT, builds affected. can affect builds CI systems however. workaround user setup PAT rather relying built one. install.packages() known issue mix binary source packages, like package recently released CRAN binary yet built. can try install packages wrong order little user remotes can fix . https://bugs.r-project.org/show_bug.cgi?id=17864 Fixing require remotes handle installation ordering already , pak . install.packages() potentially patched fix problem, getting good reproducible example seems challenging R core unresponsive issue. known incompatibility multiple sets credentials needed. instance repositories need private GitHub account need public one, don’t PAT access. don’t believe easy implement solution problem given current code. workaround use URL remote private stuff instead GitHub remote. also ongoing issues GitLab remotes various scenarios private repositories. Unfortunately don’t use GitLab enough really smooth rough edges.","code":""},{"path":"https://remotes.r-lib.org/dev/MAINTENANCE.html","id":"future-directions","dir":"","previous_headings":"","what":"Future directions","title":"NA","text":"Ideally remotes marked superseded additional development around package installation occur either pak renv.","code":""},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"package-remotes","dir":"Articles","previous_headings":"","what":"Package remotes","title":"Dependency resolution for R package development","text":"Remotes, just like devtools, supports package dependency installation packages yet standard package repository CRAN Bioconductor. can mark regular dependency defined Depends, Imports, Suggests Enhances fields installed remote location adding remote location Remotes DESCRIPTION file. cause remotes download install specified location, instead CRAN. remote dependencies specified Remotes described following form. type optional parameter. type missing default install GitHub. Additional remote dependencies separated commas, just like normal dependencies elsewhere DESCRIPTION file.","code":"Remotes: [type::], [type2::]"},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"github","dir":"Articles","previous_headings":"Package remotes","what":"GitHub","title":"Dependency resolution for R package development","text":"GitHub commonly used unofficial package distribution R, ’s default: can also specify specific hash, tag, pull request (using syntax install_github() want particular commit. Otherwise latest commit default branch used. special @*release syntax install latest release: type ‘github’ can specified, required","code":"Remotes: r-lib/testthat Remotes: r-lib/httr@v0.4, klutometis/roxygen#142, r-lib/testthat@c67018fa4970 Remotes: r-lib/testthat@*release Remotes: github::tidyverse/ggplot2"},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"other-sources","dir":"Articles","previous_headings":"Package remotes","what":"Other sources","title":"Dependency resolution for R package development","text":"currently supported install sources available, see ‘See Also’ section ?install_github complete list.","code":"# GitLab Remotes: gitlab::jimhester/covr # Git Remotes: git::git@bitbucket.org:djnavarro/lsr.git, git::https://github.com/igraph/rigraph.git@main # Bitbucket Remotes: bitbucket::sulab/mygene.r@default, djnavarro/lsr # Bioconductor Remotes: bioc::3.3/SummarizedExperiment#117513, bioc::release/Biobase # SVN Remotes: svn::https://github.com/tidyverse/stringr # URL Remotes: url::https://github.com/tidyverse/stringr/archive/HEAD.zip # Local Remotes: local::/pkgs/testthat"},{"path":"https://remotes.r-lib.org/dev/articles/dependencies.html","id":"cran-submission","dir":"Articles","previous_headings":"Package remotes","what":"CRAN submission","title":"Dependency resolution for R package development","text":"submit package CRAN, dependencies must also available CRAN. reason, devtools::release() warn try release package Remotes field.","code":""},{"path":"https://remotes.r-lib.org/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Gábor Csárdi. Author, maintainer. Jim Hester. Author. Hadley Wickham. Author. Winston Chang. Author. Martin Morgan. Author. Dan Tenenbaum. Author. . Copyright holder, funder. Ascent Digital Services. Copyright holder.","code":""},{"path":"https://remotes.r-lib.org/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Csárdi G, Hester J, Wickham H, Chang W, Morgan M, Tenenbaum D (2024). remotes: R Package Installation Remote Repositories, Including 'GitHub'. R package version 2.5.0.9000, https://github.com/r-lib/remotes#readme, https://remotes.r-lib.org.","code":"@Manual{, title = {remotes: R Package Installation from Remote Repositories, Including 'GitHub'}, author = {Gábor Csárdi and Jim Hester and Hadley Wickham and Winston Chang and Martin Morgan and Dan Tenenbaum}, year = {2024}, note = {R package version 2.5.0.9000, https://github.com/r-lib/remotes#readme}, url = {https://remotes.r-lib.org}, }"},{"path":"https://remotes.r-lib.org/dev/index.html","id":"remotes","dir":"","previous_headings":"","what":"R Package Installation from Remote Repositories, Including GitHub","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Install R Packages remote local repositories, including GitHub, GitLab, Bitbucket, Bioconductor Download install R packages stored GitHub, GitLab, Bitbucket, Bioconductor, plain subversion git repositories. package lightweight replacement install_* functions devtools. Indeed code copied devtools.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Install packages dependencies. Install GitHub, GitLab, Bitbucket. Install git subversion repositories. Install local files URLs. Install dependencies local package tree. Install specific package versions CRAN. Supports Bioconductor packages. Supports Remotes field DESCRIPTION. See dependencies vignette. Supports Additional_repositories field DESCRIPTION. Can install GitHub (see ). depend R packages. contain compiled code, compiler needed. need external software (functionality least).","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Install released version remotes CRAN:","code":"install.packages(\"remotes\")"},{"path":"https://remotes.r-lib.org/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Note examples use GitHub. See supported repository types. install latest version package default branch GitHub, can use user/repo form. Note user can also organization: R package inside subdirectory root directory, give subdirectory well: install certain branch commit tag, append repo name, @: install latest release, append @*release repo name: install pull request, append # id (integer number) pull request repo name:","code":"remotes::install_github(\"r-lib/conflicted\") # build = FALSE because of some specificities of XGBoost package install_github(\"dmlc/xgboost/R-package\", build = FALSE) remotes::install_github(\"gaborcsardi/pkgconfig@v2.0.0\") remotes::install_github(\"gaborcsardi/pkgconfig@*release\") remotes::install_github(\"r-lib/pkgconfig#7\")"},{"path":"https://remotes.r-lib.org/dev/index.html","id":"dependencies","dir":"","previous_headings":"Usage","what":"Dependencies","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Dependencies automatically installed CRAN. default, outdated dependencies automatically upgraded. interactive sessions can select subset dependencies upgrade.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"dependencies-on-github","dir":"","previous_headings":"Usage > Dependencies","what":"Dependencies on GitHub","title":"R Package Installation from Remote Repositories, Including GitHub","text":"also possible install dependencies GitHub supported repositories. need add Remotes field DESCRIPTION file. format : repo_spec repository specification corresponding install_() function can handle. remote:: missing, github:: assumed. possible values: gitlab::,bitbucket::, git::, local::, svn::, url::, version::, cran::, bioc::. See Remotes field vignette.","code":"Remotes: [remote::]repo_spec, [remote::]repo_spec, ..."},{"path":"https://remotes.r-lib.org/dev/index.html","id":"additional-repositories","dir":"","previous_headings":"Usage > Dependencies","what":"Additional repositories","title":"R Package Installation from Remote Repositories, Including GitHub","text":"remotes supports Additional_repositories field DESCRIPTION. way specify dependencies non-CRAN package repositories. See Writing R extensions manual details.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"bioconductor-packages","dir":"","previous_headings":"Usage > Dependencies","what":"Bioconductor packages","title":"R Package Installation from Remote Repositories, Including GitHub","text":"Bioconductor packages automatically detected dependencies installed Bioconductor.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"currently-supported-remote-types","dir":"","previous_headings":"Usage > Dependencies","what":"Currently supported remote types","title":"R Package Installation from Remote Repositories, Including GitHub","text":"GitHub repositories via install_github. Bitbucket repositories via install_bitbucket. Generic git repositories via install_git. need either system git installation, git2r R package. Local directories package archive files via install_local. Remote package archive files via install_url. Packages subversion repositories via install_svn. need system subversion installation. Specific package versions CRAN CRAN-like repositories via install_version. includes outdated archived packages well. dependencies package local directory via install_deps.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"download-methods","dir":"","previous_headings":"Usage","what":"Download methods","title":"R Package Installation from Remote Repositories, Including GitHub","text":"R older 3.2, curl package required remotes falls back curl::curl_download case R newer 3.3, default download.file() method used. (method = \"auto\") method = \"wininet\" used windows OS method = \"libcurl\" used OS, available. See help(\"download.file\") information methods setting proxies needed.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"standalone-mode","dir":"","previous_headings":"Usage","what":"Standalone mode","title":"R Package Installation from Remote Repositories, Including GitHub","text":"remotes use curl, git2r pkgbuild packages installed provide faster implementations aspects install process. However using remotes install update packages (reverse dependencies) using installation may fail (particularly Windows). set environment variable R_REMOTES_STANDALONE=\"true\" (e.g. R Sys.setenv(R_REMOTES_STANDALONE=\"true\")) can force remotes operate standalone mode use internal R implementations. allow successful installation packages.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"options","dir":"","previous_headings":"Usage","what":"Options","title":"R Package Installation from Remote Repositories, Including GitHub","text":"remotes uses following standard R options, see ?options details: download.file.method default download method. See ?download.file. pkgType package type (source binary, see manual) install, download look dependencies . repos locations user’s standard CRAN(-like) repositories. also uses remotes specific options: BioC_git URL default Bioconductor git mirror. BioC_mirror URL Bioconductor mirror. unzip path external unzip program.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"environment-variables","dir":"","previous_headings":"Usage","what":"Environment variables","title":"R Package Installation from Remote Repositories, Including GitHub","text":"BITBUCKET_USER BITBUCKET_PASSWORD environment variables used default Bitbucket user name password, install_bitbucket() GITHUB_PAT environment variable used default GitHub personal access token GitHub API queries. R_BIOC_MIRROR environment variable can used specify alternative Bioconductor mirror. (BioC_mirror option takes precedence .) R_BIOC_VERSION environment variable can used force Bioconductor version. R_REMOTES_UPGRADE environment variable can used set default preferred value upgrade = argument accepted various install_*() functions. example, can set R_REMOTES_UPGRADE=\"always\" upgrade dependent packages without asking user. Setting R_REMOTES_STANDALONE=\"true\" forces remotes work standalone mode avoid loading optional dependencies (curl, git2 pkgbuild currently. See “Standalone mode” . Setting R_REMOTES_NO_ERRORS_FROM_WARNINGS=\"false\" cause warning messages calls install.packages() become errors. Often warning messages caused dependencies failing install.","code":""},{"path":"https://remotes.r-lib.org/dev/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"R Package Installation from Remote Repositories, Including GitHub","text":"GPL (>= 2) © Ascent Digital Services, Posit Software, PBC","code":""},{"path":"https://remotes.r-lib.org/dev/reference/available_packages.html","id":null,"dir":"Reference","previous_headings":"","what":"Simpler available.packages — available_packages_set","title":"Simpler available.packages — available_packages_set","text":"mostly equivalent utils::available.packages() however also caches full result. Additionally cache can assigned explicitly available_packages_set() reset (cleared) available_packages_reset().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/available_packages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simpler available.packages — available_packages_set","text":"","code":"available_packages_set(repos, type, db) available_packages_reset() available_packages(repos = getOption(\"repos\"), type = getOption(\"pkgType\"))"},{"path":"https://remotes.r-lib.org/dev/reference/available_packages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simpler available.packages — available_packages_set","text":"repos character vector, base URL(s) repositories use. type character string, indicate type packages: see install.packages. type = \"\" use source repository.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":null,"dir":"Reference","previous_headings":"","what":"Tools for Bioconductor repositories — bioc_version","title":"Tools for Bioconductor repositories — bioc_version","text":"bioc_version() returns Bioconductor version current specified R version.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tools for Bioconductor repositories — bioc_version","text":"","code":"bioc_version(r_ver = getRversion()) bioc_install_repos(r_ver = getRversion(), bioc_ver = bioc_version(r_ver))"},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tools for Bioconductor repositories — bioc_version","text":"r_ver R version use. bioc_install_repos() ignored bioc_ver specified. bioc_ver Bioconductor version use. Defaults default one corresponding r_ver.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tools for Bioconductor repositories — bioc_version","text":"bioc_version() returns Bioconductor version, package_version object. bioc_install_repos() returns named character vector URLs Bioconductor repositories, appropriate current specified R version.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Tools for Bioconductor repositories — bioc_version","text":"bioc_install_repos() deduces URLs Bioconductor repositories. functions observe R_BIOC_VERSION environment variable, can set force Bioconductor version. set, r_ver bioc_ver arguments ignored. bioc_install_repos() observes R_BIOC_MIRROR environment variable also BioC_mirror option, can set desired Bioconductor mirror. option takes precedence set. default value https://bioconductor.org.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/bioc_install_repos.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Tools for Bioconductor repositories — bioc_version","text":"","code":"bioc_version() #> [1] ‘3.17’ bioc_version(\"3.4\") #> [1] ‘3.6’ bioc_install_repos() #> BioCsoft #> \"https://bioconductor.org/packages/3.17/bioc\" #> BioCann #> \"https://bioconductor.org/packages/3.17/data/annotation\" #> BioCexp #> \"https://bioconductor.org/packages/3.17/data/experiment\" #> BioCworkflows #> \"https://bioconductor.org/packages/3.17/workflows\" #> BioCbooks #> \"https://bioconductor.org/packages/3.17/books\""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a file — download","title":"Download a file — download","text":"Uses either curl package R versions older 3.2.0, otherwise wrapper around download.file().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a file — download","text":"","code":"download( path, url, auth_token = NULL, basic_auth = NULL, quiet = TRUE, headers = NULL )"},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a file — download","text":"path Path download . dirname(path) must exist. url URL. auth_token Token token-based authentication NULL. basic_auth List user password basic HTTP authentication, NULL. quiet Passed download.file() curl::curl_download(). headers Named character vector HTTP headers use.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a file — download","text":"path, download successful.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Download a file — download","text":"respect download.file.method setting user. set, see download_method() choosing method. Authentication can supplied three ways: setting auth_token. append HTTP Authorization header: Authorization: token {auth_token}. setting basic_auth list elements user password. append proper Authorization: Basic {encoded_password} HTTP header. specifying proper headers directly. auth_token basic_auth specified, error. auth_token basic_auth appended headers, take precedence Authorization header specified directly headers.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a specified version of a CRAN package — download_version","title":"Download a specified version of a CRAN package — download_version","text":"downloads package temporary file, returns name file.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a specified version of a CRAN package — download_version","text":"","code":"download_version( package, version = NULL, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a specified version of a CRAN package — download_version","text":"package Name package install. version Version package install. Can either string giving exact version required, specification format parenthesized expressions used package dependencies. One following formats: exact version required, string, e.g. \"0.1.13\" comparison operator version, e.g. \">= 0.1.12\" Several criteria satisfy, comma-separated string, e.g. \">= 1.12.0, < 1.14\" Several criteria satisfy, elements character vector, e.g. c(\">= 1.12.0\", \"< 1.14\") repos character vector, base URL(s) repositories use, e.g., URL CRAN mirror \"https://cloud.r-project.org\". details supported URL schemes see url. Can NULL install local files, directories URLs: inferred extension pkgs length one. type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/download_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a specified version of a CRAN package — download_version","text":"Name downloaded file.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/git_credentials.html","id":null,"dir":"Reference","previous_headings":"","what":"Specify git credentials to use — git_credentials","title":"Specify git credentials to use — git_credentials","text":"global option remotes.git_credentials used set git credentials.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/git_credentials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Specify git credentials to use — git_credentials","text":"","code":"git_credentials()"},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":null,"dir":"Reference","previous_headings":"","what":"GitHub references — github_pull","title":"GitHub references — github_pull","text":"Use ref parameter install_github(). Allows installing specific pull request latest release.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"GitHub references — github_pull","text":"","code":"github_pull(pull) github_release()"},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"GitHub references — github_pull","text":"pull Character string specifying pull request install","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/github_refs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"GitHub references — github_pull","text":"","code":"github_pull(\"42\") #> [1] \"42\" #> attr(,\"class\") #> [1] \"github_pull\""},{"path":"https://remotes.r-lib.org/dev/reference/github_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a new github_remote — github_remote","title":"Create a new github_remote — github_remote","text":"internal function create new github_remote, users generally need .","code":""},{"path":"https://remotes.r-lib.org/dev/reference/github_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a new github_remote — github_remote","text":"","code":"github_remote( repo, ref = \"HEAD\", subdir = NULL, auth_token = github_pat(), sha = NULL, host = \"api.github.com\", ... )"},{"path":"https://remotes.r-lib.org/dev/reference/github_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a new github_remote — github_remote","text":"repo Repository address format username/repo[/subdir][@ref|#pull|@*release]. Alternatively, can specify subdir /ref using respective parameters (see ); specified, values repo take precedence. ref Desired git reference. commit, tag, branch name, call github_pull() github_release(). Defaults \"HEAD\", means default branch GitHub git remotes. See setting--default-branch details. subdir Subdirectory within repo contains R package. auth_token install private repo, generate personal access token (PAT) least repo scope https://github.com/settings/tokens supply argument. safer using password can easily delete PAT without affecting others. Defaults GITHUB_PAT environment variable. host GitHub API host use. Override GitHub enterprise hostname, example, \"github.hostname.com/api/v3\". ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/gitlab_pat.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve GitLab personal access token. — gitlab_pat","title":"Retrieve GitLab personal access token. — gitlab_pat","text":"GitLab personal access token Looks env var GITLAB_PAT","code":""},{"path":"https://remotes.r-lib.org/dev/reference/gitlab_pat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve GitLab personal access token. — gitlab_pat","text":"","code":"gitlab_pat(quiet = TRUE)"},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a development package from the Bioconductor git repository — install_bioc","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"function requires git installed system order used.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"","code":"install_bioc( repo, mirror = getOption(\"BioC_git\", download_url(\"git.bioconductor.org/packages\")), git = c(\"auto\", \"git2r\", \"external\"), dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"repo Repository address format [username:password@][release/]repo[#commit]. Valid values release ‘devel’, ‘release’ (default none specified), numeric release numbers (e.g. ‘3.3’). mirror Bioconductor git mirror use git Whether use git2r package, external git client via system. Default git2r installed, otherwise external git installation. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"vectorised can install multiple packages single command. intended aid Bioconductor developers. want install release version Bioconductor package one can use BiocManager package.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_bioc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a development package from the Bioconductor git repository — install_bioc","text":"","code":"if (FALSE) { install_bioc(\"SummarizedExperiment\") install_bioc(\"devel/SummarizedExperiment\") install_bioc(\"3.3/SummarizedExperiment\") install_bioc(\"SummarizedExperiment#abc123\") install_bioc(\"user:password@release/SummarizedExperiment\") install_bioc(\"user:password@devel/SummarizedExperiment\") install_bioc(\"user:password@SummarizedExperiment#abc123\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package directly from Bitbucket — install_bitbucket","title":"Install a package directly from Bitbucket — install_bitbucket","text":"function vectorised can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package directly from Bitbucket — install_bitbucket","text":"","code":"install_bitbucket( repo, ref = \"HEAD\", subdir = NULL, auth_user = bitbucket_user(), password = bitbucket_password(), host = \"api.bitbucket.org/2.0\", dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package directly from Bitbucket — install_bitbucket","text":"repo Repository address format username/repo[/subdir][@ref]. Alternatively, can specify subdir /ref using respective parameters (see ); specified, values repo take precedence. ref Desired git reference; commit, tag, branch name. Defaults HEAD. subdir Subdirectory within repo contains R package. auth_user account username attempting install package hosted private repository (username different username). Defaults BITBUCKET_USER environment variable. password password. Defaults BITBUCKET_PASSWORD environment variable. See details information setting password. host GitHub API host use. Override GitHub enterprise hostname, example, \"github.hostname.com/api/v3\". dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a package directly from Bitbucket — install_bitbucket","text":"install private repo, generally, access Bitbucket API credentials, need get access token. can create access token following instructions found Bitbucket App Passwords documentation. App Password requires read-access repositories pull requests. store password environment variable BITBUCKET_PASSWORD (e.g. evelynwaugh:swordofhonour) Note Windows, authentication requires \"libcurl\" download method. can set default download method via download.file.method option: particular, unset, RStudio sets download method \"wininet\". override , might want set \"libcurl\" R profile, see base::Startup. caveat \"libcurl\" method set system proxies automatically, see \"Setting Proxies\" utils::download.file().","code":"options(download.file.method = \"libcurl\")"},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_bitbucket.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package directly from Bitbucket — install_bitbucket","text":"","code":"if (FALSE) { install_bitbucket(\"sulab/mygene.r@default\") install_bitbucket(\"djnavarro/lsr\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":null,"dir":"Reference","previous_headings":"","what":"Attempts to install a package from CRAN. — install_cran","title":"Attempts to install a package from CRAN. — install_cran","text":"function vectorised pkgs can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attempts to install a package from CRAN. — install_cran","text":"","code":"install_cran( pkgs, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attempts to install a package from CRAN. — install_cran","text":"pkgs character vector packages install. repos character vector giving repositories use. type Type package update. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_cran.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attempts to install a package from CRAN. — install_cran","text":"","code":"if (FALSE) { install_cran(\"ggplot2\") install_cran(c(\"httpuv\", \"shiny\")) }"},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Install package dependencies if needed. — install_deps","title":"Install package dependencies if needed. — install_deps","text":"Install package dependencies needed.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install package dependencies if needed. — install_deps","text":"","code":"install_deps( pkgdir = \".\", dependencies = NA, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), upgrade = c(\"default\", \"ask\", \"always\", \"never\"), quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install package dependencies if needed. — install_deps","text":"pkgdir Path package directory, package tarball. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. repos character vector giving repositories use. type Type package update. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). ... additional arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_deps.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install package dependencies if needed. — install_deps","text":"","code":"if (FALSE) install_deps(\".\")"},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":null,"dir":"Reference","previous_headings":"","what":"Install the development version of a package — install_dev","title":"Install the development version of a package — install_dev","text":"install_dev() retrieves package DESCRIPTION CRAN mirror looks 'URL' 'BugReports' fields GitHub, GitLab Bitbucket URLs. calls appropriate install_() function install development package.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install the development version of a package — install_dev","text":"","code":"install_dev(package, cran_url = getOption(\"repos\")[[\"CRAN\"]], ...)"},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install the development version of a package — install_dev","text":"package package name install. cran_url URL CRAN mirror use, default based 'repos' option. unset uses 'https://cloud.r-project.org'. ... Additional arguments passed install_github(), install_gitlab(), install_bitbucket() functions.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_dev.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install the development version of a package — install_dev","text":"","code":"if (FALSE) { # From GitHub install_dev(\"dplyr\") # From GitLab install_dev(\"iemiscdata\") # From Bitbucket install_dev(\"argparser\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a git repository — install_git","title":"Install a package from a git repository — install_git","text":"vectorised can install multiple packages single command. need git2r package, external git client installed.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a git repository — install_git","text":"","code":"install_git( url, subdir = NULL, ref = NULL, branch = NULL, credentials = git_credentials(), git = c(\"auto\", \"git2r\", \"external\"), dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a git repository — install_git","text":"url Location package. url point public private repository. subdir sub-directory within git repository may contain package interested installing. ref Name branch, tag SHA reference use, HEAD. branch Deprecated, synonym ref. credentials git2r credentials object passed clone. Supplying argument implies using git2r git. git Whether use git2r package, external git client via system. Default git2r installed, otherwise external git installation. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a package from a git repository — install_git","text":"need set git credentials use Remotes field can placing credentials remotes.git_credentials global option.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_git.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a git repository — install_git","text":"","code":"if (FALSE) { install_git(\"https://github.com/hadley/stringr.git\") install_git(\"https://github.com/hadley/stringr.git\", ref = \"stringr-0.2\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":null,"dir":"Reference","previous_headings":"","what":"Attempts to install a package directly from GitHub. — install_github","title":"Attempts to install a package directly from GitHub. — install_github","text":"function vectorised repo can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attempts to install a package directly from GitHub. — install_github","text":"","code":"install_github( repo, ref = \"HEAD\", subdir = NULL, auth_token = github_pat(quiet), host = \"api.github.com\", dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attempts to install a package directly from GitHub. — install_github","text":"repo Repository address format username/repo[/subdir][@ref|#pull|@*release]. Alternatively, can specify subdir /ref using respective parameters (see ); specified, values repo take precedence. ref Desired git reference. commit, tag, branch name, call github_pull() github_release(). Defaults \"HEAD\", means default branch GitHub git remotes. See setting--default-branch details. subdir Subdirectory within repo contains R package. auth_token install private repo, generate personal access token (PAT) least repo scope https://github.com/settings/tokens supply argument. safer using password can easily delete PAT without affecting others. Defaults GITHUB_PAT environment variable. host GitHub API host use. Override GitHub enterprise hostname, example, \"github.hostname.com/api/v3\". dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_github.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Attempts to install a package directly from GitHub. — install_github","text":"repository uses submodules command-line git client required clone submodules.","code":""},{"path":[]},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from GitLab — install_gitlab","title":"Install a package from GitLab — install_gitlab","text":"function vectorised repo can install multiple packages single command. Like remotes repository skip installation force == FALSE (default) remote state changed since previous installation.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from GitLab — install_gitlab","text":"","code":"install_gitlab( repo, subdir = NULL, auth_token = gitlab_pat(quiet), host = \"gitlab.com\", dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from GitLab — install_gitlab","text":"repo Repository address format username/repo[@ref]. subdir Subdirectory within repo contains R package. auth_token install private repo, generate personal access token (PAT) least read_api scope https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html supply argument. safer using password can easily delete PAT without affecting others. Defaults GITLAB_PAT environment variable. host GitLab API host use. Override GitLab enterprise hostname, example, \"gitlab.hostname.com\". PROTOCOL required packrat Posit Connect deployment. install_gitlab may work without, omitting generally leads package restoration errors. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_gitlab.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from GitLab — install_gitlab","text":"","code":"if (FALSE) { install_gitlab(\"jimhester/covr\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a local file — install_local","title":"Install a package from a local file — install_local","text":"function vectorised can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a local file — install_local","text":"","code":"install_local( path = \".\", subdir = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = !is_binary_pkg(path), build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a local file — install_local","text":"path path local directory, compressed file (tar, zip, tar.gz tar.bz2, tgz2 tbz) subdir subdirectory within url bundle contains R package. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_local.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a local file — install_local","text":"","code":"if (FALSE) { dir <- tempfile() dir.create(dir) pkg <- download.packages(\"testthat\", dir, type = \"source\") install_local(pkg[, 2]) }"},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a remote package. — install_remote","title":"Install a remote package. — install_remote","text":": downloads source bundle decompresses & checks package adds metadata DESCRIPTION calls install","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a remote package. — install_remote","text":"","code":"install_remote( remote, dependencies, upgrade, force, quiet, build, build_opts, build_manual, build_vignettes, repos, type, ... ) add_metadata(pkg_path, meta) remote_download(x, quiet = FALSE) remote_metadata(x, bundle = NULL, source = NULL, sha = NULL) remote_package_name(remote, ...) remote_sha(remote, ...)"},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a remote package. — install_remote","text":"dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_remote.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a remote package. — install_remote","text":"uses additional S3 generic functions work. Writing methods functions allow 3rd party packages define custom remotes.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a SVN repository — install_svn","title":"Install a package from a SVN repository — install_svn","text":"function requires svn installed system order used.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a SVN repository — install_svn","text":"","code":"install_svn( url, subdir = NULL, args = character(0), revision = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a SVN repository — install_svn","text":"url Location package. url point public private repository. subdir sub-directory within svn repository contains package interested installing. args character vector providing extra options pass svn. revision svn revision, omitted updates latest dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install a package from a SVN repository — install_svn","text":"vectorised can install multiple packages single command.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_svn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a SVN repository — install_svn","text":"","code":"if (FALSE) { install_svn(\"https://github.com/hadley/stringr/trunk\") install_svn(\"https://github.com/hadley/httr/branches/oauth\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a package from a url — install_url","title":"Install a package from a url — install_url","text":"function vectorised can install multiple packages single command.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a package from a url — install_url","text":"","code":"install_url( url, subdir = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a package from a url — install_url","text":"url location package internet. url point zip file, tar file bzipped/gzipped tar file. subdir subdirectory within url bundle contains R package. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_url.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a package from a url — install_url","text":"","code":"if (FALSE) { install_url(\"https://github.com/hadley/stringr/archive/HEAD.zip\") }"},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Install specific version of a package. — install_version","title":"Install specific version of a package. — install_version","text":"function knows look multiple CRAN-like package repositories, archive directories, order find specific versions requested package.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install specific version of a package. — install_version","text":"","code":"install_version( package, version = NULL, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = FALSE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = \"source\", ... )"},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install specific version of a package. — install_version","text":"package Name package install. version Version package install. Can either string giving exact version required, specification format parenthesized expressions used package dependencies. One following formats: exact version required, string, e.g. \"0.1.13\" comparison operator version, e.g. \">= 0.1.12\" Several criteria satisfy, comma-separated string, e.g. \">= 1.12.0, < 1.14\" Several criteria satisfy, elements character vector, e.g. c(\">= 1.12.0\", \"< 1.14\") dependencies logical indicating whether also install uninstalled packages packages depend /link /import/suggest (recursively). used repos = NULL. Can also character vector, subset c(\"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"). supported lib length one (missing), unambiguous install dependent packages. case ignored, warning. default, NA, means c(\"Depends\", \"Imports\", \"LinkingTo\"). TRUE means use c(\"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\") pkgs c(\"Depends\", \"Imports\", \"LinkingTo\") added dependencies: installs packages needed run pkgs, examples, tests vignettes (package author specified correctly). , \"LinkingTo\" omitted binary packages. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet logical: true, reduce amount output. passed available.packages() case called, purpose. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector, base URL(s) repositories use, e.g., URL CRAN mirror \"https://cloud.r-project.org\". details supported URL schemes see url. Can NULL install local files, directories URLs: inferred extension pkgs length one. type character, indicating type package download install. \"source\" except Windows macOS builds: see section ‘Binary packages’ . ... arguments passed utils::install.packages().","code":""},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Install specific version of a package. — install_version","text":"repositories searched order specified repos argument. enables teams maintain multiple -house repositories different policies - instance, one repo development snapshots one official releases. common setup first search official release repo, dev snapshot repo, public CRAN mirror. Older versions packages CRAN usually available source form. requested package contains compiled code, need R development environment installed. can check running devtools::has_devel (need devtools package ).","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/install_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install specific version of a package. — install_version","text":"","code":"if (FALSE) { install_version(\"devtools\", \"1.11.0\") install_version(\"devtools\", \">= 1.12.0, < 1.14\") ## Specify search order (e.g. in ~/.Rprofile) options(repos = c( prod = \"http://mycompany.example.com/r-repo\", dev = \"http://mycompany.example.com/r-repo-dev\", CRAN = \"https://cran.revolutionanalytics.com\" )) install_version(\"mypackage\", \"1.15\") # finds in 'prod' install_version(\"mypackage\", \"1.16-39487\") # finds in 'dev' }"},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Find all dependencies of a CRAN or dev package. — package_deps","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"Find dependencies package determine whether ahead behind CRAN. print() method identifies mismatches () local CRAN versions dependent package; update() method installs outdated missing packages CRAN.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"","code":"package_deps( packages, dependencies = NA, repos = getOption(\"repos\"), type = getOption(\"pkgType\") ) local_package_deps(pkgdir = \".\", dependencies = NA) dev_package_deps( pkgdir = \".\", dependencies = NA, repos = getOption(\"repos\"), type = getOption(\"pkgType\") ) # S3 method for package_deps update( object, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"packages character vector package names. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. repos character vector giving repositories use. type Type package update. pkgdir Path package directory, package tarball. object package_deps object. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Force installation, even remote state changed since previous install. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). ... Additional arguments passed install_packages.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"data.frame columns:","code":""},{"path":"https://remotes.r-lib.org/dev/reference/package_deps.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Find all dependencies of a CRAN or dev package. — package_deps","text":"","code":"if (FALSE) { package_deps(\"devtools\") # Use update to update any out-of-date dependencies update(package_deps(\"devtools\")) }"},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a remote git repo specification — parse-git-repo","title":"Parse a remote git repo specification — parse-git-repo","text":"remote repo can specified two ways: URL parse_github_url() handles HTTPS SSH remote URLs various GitHub browser URLs via shorthand parse_repo_spec() handles concise form: [username/]repo[/subdir][#pull|@ref|@*release]","code":""},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a remote git repo specification — parse-git-repo","text":"","code":"parse_repo_spec(repo) parse_github_repo_spec(repo) parse_github_url(repo)"},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse a remote git repo specification — parse-git-repo","text":"repo Character scalar, repo specification.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse a remote git repo specification — parse-git-repo","text":"List members: username, repo, subdir ref, pull, release, empty.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/parse-git-repo.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse a remote git repo specification — parse-git-repo","text":"","code":"parse_repo_spec(\"metacran/crandb\") #> $package #> [1] \"\" #> #> $username #> [1] \"metacran\" #> #> $repo #> [1] \"crandb\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"jimhester/covr#47\") ## pull request #> $package #> [1] \"\" #> #> $username #> [1] \"jimhester\" #> #> $repo #> [1] \"covr\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"47\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"jeroen/curl@v0.9.3\") ## specific tag #> $package #> [1] \"\" #> #> $username #> [1] \"jeroen\" #> #> $repo #> [1] \"curl\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"v0.9.3\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"tidyverse/dplyr@*release\") ## shorthand for latest release #> $package #> [1] \"\" #> #> $username #> [1] \"tidyverse\" #> #> $repo #> [1] \"dplyr\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"*release\" #> parse_repo_spec(\"r-lib/remotes@550a3c7d3f9e1493a2ba\") ## commit SHA #> $package #> [1] \"\" #> #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"550a3c7d3f9e1493a2ba\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_repo_spec(\"igraph=igraph/rigraph\") ## Different package name from repo name #> $package #> [1] \"igraph\" #> #> $username #> [1] \"igraph\" #> #> $repo #> [1] \"rigraph\" #> #> $subdir #> [1] \"\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/jeroen/curl.git\") #> $username #> [1] \"jeroen\" #> #> $repo #> [1] \"curl\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"git@github.com:metacran/crandb.git\") #> $username #> [1] \"metacran\" #> #> $repo #> [1] \"crandb\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/jimhester/covr\") #> $username #> [1] \"jimhester\" #> #> $repo #> [1] \"covr\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.example.com/user/repo.git\") #> $username #> [1] \"user\" #> #> $repo #> [1] \"repo\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"git@github.example.com:user/repo.git\") #> $username #> [1] \"user\" #> #> $repo #> [1] \"repo\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/pull/108\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"108\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/tree/name-of-branch\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"name-of-branch\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/commit/1234567\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"1234567\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #> parse_github_url(\"https://github.com/r-lib/remotes/releases/latest\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"*release\" #> parse_github_url(\"https://github.com/r-lib/remotes/releases/tag/1.0.0\") #> $username #> [1] \"r-lib\" #> #> $repo #> [1] \"remotes\" #> #> $ref #> [1] \"1.0.0\" #> #> $pull #> [1] \"\" #> #> $release #> [1] \"\" #>"},{"path":"https://remotes.r-lib.org/dev/reference/remotes-package.html","id":null,"dir":"Reference","previous_headings":"","what":"remotes: R Package Installation from Remote Repositories, Including 'GitHub' — remotes-package","title":"remotes: R Package Installation from Remote Repositories, Including 'GitHub' — remotes-package","text":"Download install R packages stored 'GitHub', 'GitLab', 'Bitbucket', 'Bioconductor', plain 'subversion' 'git' repositories. package provides 'install_*' functions 'devtools'. Indeed code copied 'devtools'.","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/remotes-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"remotes: R Package Installation from Remote Repositories, Including 'GitHub' — remotes-package","text":"Maintainer: Gábor Csárdi csardi.gabor@gmail.com Authors: Jim Hester Hadley Wickham Winston Chang Martin Morgan Dan Tenenbaum contributors: Posit Software, PBC [copyright holder, funder] Ascent Digital Services [copyright holder]","code":""},{"path":"https://remotes.r-lib.org/dev/reference/standardise_dep.html","id":null,"dir":"Reference","previous_headings":"","what":"Standardise dependencies using the same logical as install.packages — standardise_dep","title":"Standardise dependencies using the same logical as install.packages — standardise_dep","text":"Standardise dependencies using logical install.packages","code":""},{"path":"https://remotes.r-lib.org/dev/reference/standardise_dep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Standardise dependencies using the same logical as install.packages — standardise_dep","text":"","code":"standardise_dep(x)"},{"path":"https://remotes.r-lib.org/dev/reference/standardise_dep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Standardise dependencies using the same logical as install.packages — standardise_dep","text":"x dependencies standardise. character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies. value \"soft\" means TRUE, \"hard\" means NA. additional values match one standard dependency types filtered .","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":null,"dir":"Reference","previous_headings":"","what":"Query the system requirements for a package (and its dependencies) — system_requirements","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"Returns character vector commands run install system requirements queried operating system.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"","code":"system_requirements( os, os_release = NULL, path = \".\", package = NULL, curl = Sys.which(\"curl\") )"},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"os, os_release operating system operating system release version, see https://github.com/rstudio/r-system-requirements#operating-systems list supported operating systems. os_release NULL, os must consist operating system version separated dash, e.g. \"ubuntu-18.04\". path path dev package's root directory. package CRAN package name(s) lookup system requirements . NULL, used path ignored. curl location curl binary system.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/system_requirements.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Query the system requirements for a package (and its dependencies) — system_requirements","text":"character vector commands needed install system requirements package.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":null,"dir":"Reference","previous_headings":"","what":"Update packages that are missing or out-of-date. — update_packages","title":"Update packages that are missing or out-of-date. — update_packages","text":"Works similarly utils::install.packages() install packages already installed, also upgrades dated dependencies.","code":""},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update packages that are missing or out-of-date. — update_packages","text":"","code":"update_packages( packages = TRUE, dependencies = NA, upgrade = c(\"default\", \"ask\", \"always\", \"never\"), force = FALSE, quiet = FALSE, build = TRUE, build_opts = c(\"--no-resave-data\", \"--no-manual\", \"--no-build-vignettes\"), build_manual = FALSE, build_vignettes = FALSE, repos = getOption(\"repos\"), type = getOption(\"pkgType\"), ... )"},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update packages that are missing or out-of-date. — update_packages","text":"packages Character vector packages update. dependencies dependencies want check? Can character vector (selecting \"Depends\", \"Imports\", \"LinkingTo\", \"Suggests\", \"Enhances\"), logical vector. TRUE shorthand \"Depends\", \"Imports\", \"LinkingTo\" \"Suggests\". NA shorthand \"Depends\", \"Imports\" \"LinkingTo\" default. FALSE shorthand dependencies (.e. just check package, dependencies). value \"soft\" means TRUE, \"hard\" means NA. can also specify dependencies one additional fields, common ones include: Config/Needs/website - dependencies used building pkgdown site. Config/Needs/coverage dependencies used calculating test coverage. upgrade package dependencies upgraded? One \"default\", \"ask\", \"always\", \"never\". \"default\" respects value R_REMOTES_UPGRADE environment variable set, falls back \"ask\" unset. \"ask\" prompts user date packages upgrade. non-interactive sessions \"ask\" equivalent \"always\". TRUE FALSE also accepted correspond \"always\" \"never\" respectively. force Deprecated, argument effect. quiet TRUE, suppress output. build TRUE build package installing. build_opts Options pass R CMD build, used build TRUE. build_manual FALSE, build PDF manual ('---manual'). build_vignettes FALSE, build package vignettes ('---build-vignettes'). repos character vector giving repositories use. type Type package update. ... arguments passed utils::install.packages().","code":""},{"path":[]},{"path":"https://remotes.r-lib.org/dev/reference/update_packages.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update packages that are missing or out-of-date. — update_packages","text":"","code":"if (FALSE) { update_packages(\"ggplot2\") update_packages(c(\"plyr\", \"ggplot2\")) }"},{"path":[]},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-250","dir":"Changelog","previous_headings":"","what":"remotes 2.5.0","title":"remotes 2.5.0","text":"CRAN release: 2024-03-17 install_github() now uses credentials git credential store, GITHUB_PAT GITHUB_TOKEN set. Remotes field DESCRIPTION now accepts explicit package names: =::/ (#719, @heavywatal). dev_package_deps() now works packages Enhances dependencies (#711, @maksymiuks). install_dev() now ignores trailing slash (#692, @krlmlr). System requirements now support Ubuntu 22.04. local_package_deps() now errors non-existent directories (#772, @MatthieuStigler).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-242","dir":"Changelog","previous_headings":"","what":"remotes 2.4.2","title":"remotes 2.4.2","text":"CRAN release: 2021-11-30 Gábor Csárdi now maintainer. bioc_version() now points recent (2021-10-27) Bioconductor release, v3.14 (@stufield, #664). Fix regex handle user names URL git_remote, add regression tests (@achimgaedke, #646).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-241","dir":"Changelog","previous_headings":"","what":"remotes 2.4.1","title":"remotes 2.4.1","text":"CRAN release: 2021-09-29 pkgbuild longer accidentally loaded even standalone mode (#548) internal GitHub token used increase rate limits regenerated. Using remote_package_name.git2r_remote now passes credentials looking package DESCRIPTION (#633, @rnorberg) Using remote_package_name.git2r_remote remote_package_name.xgit_remote, http responses returning invalid DESCRIPTION redirect another page now fallback return NA instead throwing error trying parse unexpected content (#628, @dgkf). Fix regex breaks git protocol git_remote (@niheaven #630). Clarify github_pull() documentation (@ms609 #640).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-240","dir":"Changelog","previous_headings":"","what":"remotes 2.4.0","title":"remotes 2.4.0","text":"CRAN release: 2021-06-02 Re-license MIT. (#551) Fix bug install_bioc() using version=‘devel’. code now pull git HEAD, branch named ‘HEAD’ (@bbimber, #612). skip tests download.file(method = \"internal\"), R > 4.1, since method now defunct versions. system_requirements() now works intended os argument used (@mdneuzerling, #609) remote_package_name.git2r_remote remote_package_name.xgit_remote now get correct package name HTTP(S) git repo’s DESCRIPTION file, thus package’s DESCRIPTION file’s Remotes field git::http(s):////[.git][@ref] items install remote packages using git via HTTP(S) protocol (@niheaven, #603).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-230","dir":"Changelog","previous_headings":"","what":"remotes 2.3.0","title":"remotes 2.3.0","text":"CRAN release: 2021-04-01","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"major-changes-2-3-0","dir":"Changelog","previous_headings":"","what":"Major changes","title":"remotes 2.3.0","text":"install_*() functions longer fail default warnings install.packages(). Concretely default value R_REMOTES_NO_ERRORS_FROM_WARNINGS changed true previous value false. (#403)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-3-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.3.0","text":"install_bioc() now respects environment variable R_BIOC_VERSION, use git branch corresponding Bioconductor version (@bbimber, #580). remotes without package names now unconditionally installed (#532, @jakubkovac) now possible specify custom host dependencies listed DESCRIPTION file Remotes: [@host]::/[@ref]. ref now supports / GitLab repositories GitHubrepositories. (@dagola, #448) Internal package2remote() function now supports local remotes created pak. github_pat() now check GITHUB_TOKEN set find GITHUB_PAT. (@coatless) system_requirements() now supports querying released packages well development dependencies (#545) system_requirements() now supports OS name + version os argument (#549, @krlmlr).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-220","dir":"Changelog","previous_headings":"","what":"remotes 2.2.0","title":"remotes 2.2.0","text":"CRAN release: 2020-07-21","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"new-functions-and-features-2-2-0","dir":"Changelog","previous_headings":"","what":"New functions and features","title":"remotes 2.2.0","text":"New system_requirements() function query Public RStudio Package Manager system requirements package (dependencies) Remotes functions can now install dependencies additional DESCRIPTION fields, e.g. passing dependencies = \"Config/Needs/website\" install dependencies listed Config/Needs/website: field package’s DESCRIPTION. Prefixing fields Config/Needs allows pass R CMD check without NOTE, recommended format extra dependencies. install_*() family functions now use default branch repository, master branch (@MyKo101,#508).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-2-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.2.0","text":"Internal functions remote_download(), remote_metadata(), remote_package_name() remote_sha() now exported, 3rd party packages provide methods new remote types (#509, #56) Internal functions add_metadata(), github_remote() now exported. mainly 3rd party extensions used users (#485). install_version() now keeps searching subsequent repositories requested version, rather failing version finds early repository unsuitable. (#305, @kenahoo) install_version() now understands specifications like ‘>= 1.0’ ‘>= 1.12.0, < 1.14’ install first version package can find satisfies criteria. (#305, @kenahoo) install_version() now avoids use base::url(), prior R 3.6.2 bug downloading large files (#463) parse_submodules() internal regular expression now PCRE 2 compatible (#502, @jan-glx) update_packages() argument force deprecated longer effect (#521) Another fix mixed binary source dependency issue, hopefully fully squashed now (#296) upgrade menu now interruptible RStudio (#489). Internal GitHub functions now correctly handle cases characters representable default locale, representable UTF-8 (#492).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-211","dir":"Changelog","previous_headings":"","what":"remotes 2.1.1","title":"remotes 2.1.1","text":"CRAN release: 2020-02-15","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-1-1","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.1.1","text":"Installing mixed binary source dependencies latest versions packages binaries yet now install dependencies correct order prevent load failures (#296) github_error() now also works GitHub (Enterprise) server return information rate limit (@dpprdan, #396, #413). install_gitlab passes quiet argument gitlab_pat (@michaelchirico, #437) remotes now resilient installed packages declare RemoteType: standard include RemoteRepos RemotePkgType field. case, values getOption(\"repos\") getOption(\"pkgType\") used (respectively). install_gitlab() now installs repositories subgroups dots name. subdir now explicit argument instead implicit repo (@robertdj, #259, #420). install() now passes ellipsis ... install_deps() (@Neil-Schneider, #411) tests updated work newer versions callr R 4.0","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-210","dir":"Changelog","previous_headings":"","what":"remotes 2.1.0","title":"remotes 2.1.0","text":"CRAN release: 2019-06-24","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"new-features-2-1-0","dir":"Changelog","previous_headings":"","what":"New features","title":"remotes 2.1.0","text":"install_*() functions gain build_manual build_vignette arguments previously existed devtools versions < 2.0 (#353). interactive menu modified provide clear instructions skipping behavior (#207) Credentials now passed via HTTP headers, reduce exposure requests fail (#391).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-1-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.1.0","text":"download() external curl download method now always uses -L follow redirects. (#350) update_packages() now informative error message update fails (#223, #232) install_git() now can take credentials global option remotes.git_credentials (#378). install_git() now works SHA references external git (#389). GitHub remotes point branches longer fail branch later deleted (#274). Local remotes whose original location moved longer error updating (#370). update_deps() longer sorts dependencies alphabetically (#296, #301) github_resolve_ref() now takes host parameter (#284) Remotes specific environment variables now accept 0 1 valid values (#238) remotes now uses locking default installing binary packages, avoids issues installing binaries already open R processes (#368) update_deps() longer fails local package longer exists (#289) install_version() now errors informative message type ‘source’ (#323) Bioc remote_sha() now always returns character result (#379) Fix API call private repositories install_gitlab (@aornugent, #359, #363) git submodules now work submodule file empty (@muschellij2, #234) git submodules now work R package stored subfolder (@pommedeterresautee, #233) install_gitlab() longer adds access token twice request (@aornugent, #363). Bitbucket dependencies now actually use BITBUCKET_USER BITBUCKET_PASSWORD environment variables (@antoine-sachet, #347). parse_deps() now ignores trailing whitespaces around comparison operators DESCRIPTION fields (@LiNk-NY, #366)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-204","dir":"Changelog","previous_headings":"","what":"remotes 2.0.4","title":"remotes 2.0.4","text":"CRAN release: 2019-04-10 update.package_dependencies() now uses pkg_type cran remote rather global type attribute, fixing errors global attribute lost (#291, #304). Credentials longer passed dependencies, breaks dependencies use different credentials hosts. relied behavior robust way provide credentials using appropriate environment variables, e.g. GITHUB_PAT, BITBUCKET_USER etc. (@antoine-sachet, #345). hash bitbucket hosts now correctly retrieved (@antoine-sachet, #344) Fix parsing Additional_Repositories leading newline (@tmelliott, #251).","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-203","dir":"Changelog","previous_headings":"","what":"remotes 2.0.3","title":"remotes 2.0.3","text":"CRAN release: 2019-04-09 order choices upgrade = \"ask\" now puts stable ones ‘’, ‘CRAN ’, ‘none’ first, always numbers (#287). update_submodules() now works empty .gitmodules files (@jsilve24, #329). remotes now understands “standard” remote type, produced packages installed CRAN using pak (#309) install_dev() now supports ref/pull format, e.g. install_dev('shiny@v1.2-rc') (@mkearney, #279). Fix return type install_remote() circular dependency (#225) remote_package_name.github_remote() now works properly Windows (#248) install_bioc() repositories now updated Bioconductor 3.8 release. (#239) install_* functions now set R_LIBS* environment variables child processes correctly Windows (@HenrikBengtsson, #253) install_* functions now support R_REMOTES_UPGRADE environment variable, set default upgrade argument. See README details (@kevinushey, #240). install_* functions perform basic HTTP authentication using HTTP headers now. fixes issue install_bitbucket() private repos (#255). install_* functions now respect download.file.method option, download_file() used HTTP. install_* functions now use libcurl method, download.file.method option set different one, libcurl available. , wininet method preferred Windows. rely proxy configuration wininet, might want set download.file.method option, use another way set proxies, see ?download.file. Remotes without package names now unconditionally installed (#246). install_github() now includes informative error message status code 404, asking user check spelled repo owner repo correctly (included error message), required permissions access repository. install_* functions (via underlying private install function) now set RGL_USE_NULL=\"TRUE\" order avoid errors running headless installing package using rgl (@jefferis, ##333)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-202","dir":"Changelog","previous_headings":"","what":"remotes 2.0.2","title":"remotes 2.0.2","text":"CRAN release: 2018-10-30 install_deps() now installs un-installed remotes packages even upgrade = \"never\" (@ankane, #227) install_version() now removes metadata added byproduct using install_url() internally() (#224) install() now avoids converting warnings errors R_REMOTES_NO_ERRORS_FROM_WARNINGS unset _R_CHECK_FORCE_SUGGESTS_=false. avoids failures due Suggested packages potentially missing. install_bitbucket() now works properly packages subdirectories (#220) install_deps() now installs un-installed packages even upgrade = \"never\" (#218)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-201","dir":"Changelog","previous_headings":"","what":"remotes 2.0.1","title":"remotes 2.0.1","text":"CRAN release: 2018-10-19 install_github() now bundles GitHub PAT used Travis avoid hitting rate limit frequently. also contains informative error message rate limit hit setup GitHub personal access token. dialog upgrade = \"ask\" now ‘CRAN ’ option, update CRAN packages. longer include project specific .Rprofile code temporary .Rprofile R_REMOTES_NO_ERRORS_FROM_WARNINGS=false (default). update.package_deps() longer prompts install uninstalled dependencies, always installed (#203). available_packages(), available_packages_set() available_packges_reset() added allow caching available.packages() database.","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-200","dir":"Changelog","previous_headings":"","what":"remotes 2.0.0","title":"remotes 2.0.0","text":"CRAN release: 2018-10-11","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"breaking-changes-2-0-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"remotes 2.0.0","text":"install_github()’s previously deprecated username argument removed. (#142) install_deps()’s threads argument removed, use Ncpus argument instead (#153, #154) install_git()’s branch argument renamed ref branch deprecated.","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"new-features-2-0-0","dir":"Changelog","previous_headings":"","what":"New features","title":"remotes 2.0.0","text":"remotes now builds packages default installing . step uses pkgbuild package, available. , calls R CMD build directly. New install_dev() install development version CRAN package, based URL BugReports fields DESCRIPTION file (#144). install_()* functions now temporally put Rtools PATH necessary, long pkgbuild package installed. remotes can forced use internal code setting environment variable R_REMOTES_STANDALONE = “true”. useful installing optional dependencies remotes Windows, curl git2r (#147) installing, remotes now errors warnings, catch cases packages partially installed. often happens windows package dll opened another R process (#113). install_() functions now pass arguments, including authentication information upgrade dependencies (#53, #86, #87). install_() functions allow selection subset packages upgrade, interactive mode, upgrade = \"ask\". install_git() now supports passing credentials, used git = \"git2r\" (#106) install_() functions now return name package(s) installed (#55). git submodules now installed exist git client available (#138, #133, #103, #82). New install_gitlab() install_bioc() functions, install gitlab bioc remote types. remotes now uses SHA updating logic remotes devtools, including checking SHA remote changed since last installation. (#135) install_url() can now install package binaries windows (r-lib/devtools#1765)","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"minor-improvements-and-fixes-2-0-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"remotes 2.0.0","text":"install_deps() et al. now rewrite type argument binary allow falling back source. fixes various installation failures. remotes now looks GitHub package names locally, possible, uses GitHub REST API (curl package available, standalone mode). makes remote lookup 10x faster remote package changed since last install. Using GITHUB_PAT longer prints diagnostic messages default (r-lib/devtools#1752). remotes now always uses https URLs R versions support (@ankane, #139) include BioCextra repository versions deprecated (R 3.5+, Bioc 3.6+). install_() functions now download tarballs (.tar.gz) files rather zip archives (.zip). results generally smaller files avoids issues script permissions lost strange behavior external unzip programs Windows (#96). Dependency parsing now robust whitespace around dependency specifications (#73). standardise_dep() exported, use devtools. install_local() now defaults current directory. install_bitbucket() now correctly supports authentication, subdir argument. install_() functions give helpful warning package long path names, Windows. case building package usually fails. (#84, #178). install_() functions now robust way handling various tar programs Windows (#172). install_() functions now give helpful warning older R versions, Windows, R.home() contains space character. Installation usually fails case. GitHub API errors now give better error messages, including data API rate limits.","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-111","dir":"Changelog","previous_headings":"","what":"remotes 1.1.1","title":"remotes 1.1.1","text":"CRAN release: 2017-12-20 Accept HTTPS, SSH, various browser URLs GitHub repo specification, @jennybc, #90, #109, #112","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-110","dir":"Changelog","previous_headings":"","what":"remotes 1.1.0","title":"remotes 1.1.0","text":"CRAN release: 2017-07-09 URL encode GitHub references, allow installing non-alphanumeric branch tags, @krlmlr #38 Better cooperation proxy servers, better download method selection Windows, @cderv, #45, #46 install_deps() supports tar balls, #47 Allow training slash GitHub repo specification, #54 Work around Linux systems, unzip set empty string, @HenrikBengtsson, #57 Check circular dependencies installing, #31 Updated Bioconductor repo URLs newer BioC versions","code":""},{"path":"https://remotes.r-lib.org/dev/news/index.html","id":"remotes-100","dir":"Changelog","previous_headings":"","what":"remotes 1.0.0","title":"remotes 1.0.0","text":"CRAN release: 2016-09-10 First public release.","code":""}]
Csárdi G, Hester J, Wickham H, Chang W, Morgan M, Tenenbaum D (2024). remotes: R Package Installation from Remote Repositories, Including 'GitHub'. -R package version 2.4.2.9000, https://github.com/r-lib/remotes#readme, https://remotes.r-lib.org. +R package version 2.5.0.9000, https://github.com/r-lib/remotes#readme, https://remotes.r-lib.org.
@Manual{, title = {remotes: R Package Installation from Remote Repositories, Including 'GitHub'}, author = {Gábor Csárdi and Jim Hester and Hadley Wickham and Winston Chang and Martin Morgan and Dan Tenenbaum}, year = {2024}, - note = {R package version 2.4.2.9000, https://github.com/r-lib/remotes#readme}, + note = {R package version 2.5.0.9000, https://github.com/r-lib/remotes#readme}, url = {https://remotes.r-lib.org}, }
NEWS.md
CRAN release: 2024-03-17
install_github()
GITHUB_PAT
GITHUB_TOKEN
Remotes
DESCRIPTION
<pkgname>=<type>::<username>/<repo>
dev_package_deps()
Enhances
install_dev()
local_package_deps()
CRAN release: 2021-11-30