{"id":14067985,"url":"https://github.com/r-lib/remotes","last_synced_at":"2025-05-14T00:06:58.875Z","repository":{"id":41541791,"uuid":"48906138","full_name":"r-lib/remotes","owner":"r-lib","description":"Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs","archived":false,"fork":false,"pushed_at":"2025-02-25T15:15:04.000Z","size":10213,"stargazers_count":343,"open_issues_count":129,"forks_count":154,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-05-10T11:52:29.370Z","etag":null,"topics":["r"],"latest_commit_sha":null,"homepage":"https://remotes.r-lib.org/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/r-lib.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-02T10:24:31.000Z","updated_at":"2025-04-18T11:31:51.000Z","dependencies_parsed_at":"2023-02-18T12:46:11.038Z","dependency_job_id":"51f6ee5f-5368-44ca-bb13-50a55aac4d91","html_url":"https://github.com/r-lib/remotes","commit_stats":{"total_commits":837,"total_committers":76,"mean_commits":"11.013157894736842","dds":0.5519713261648745,"last_synced_commit":"5b7eb08f70ecc4f885f2c75330ce77f87e7dd14e"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fremotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fremotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fremotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fremotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/r-lib","download_url":"https://codeload.github.com/r-lib/remotes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254043615,"owners_count":22004978,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["r"],"created_at":"2024-08-13T07:05:52.937Z","updated_at":"2025-05-14T00:06:58.857Z","avatar_url":"https://github.com/r-lib.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# remotes\n\n\u003e Install R Packages from remote or local repositories,\n\u003e including GitHub, GitLab, Bitbucket, and Bioconductor\n\n\n\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/r-lib/remotes/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/remotes/actions/workflows/R-CMD-check.yaml)\n[![Codecov test coverage](https://codecov.io/gh/r-lib/remotes/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/remotes?branch=main)\n[![CRAN Posit mirror downloads](https://cranlogs.r-pkg.org/badges/remotes)](https://www.r-pkg.org/pkg/remotes)\n[![](https://www.r-pkg.org/badges/version/remotes)](https://www.r-pkg.org/pkg/remotes)\n[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)\n\u003c!-- badges: end --\u003e\n\nDownload and install R packages stored in GitHub, GitLab, Bitbucket,\nBioconductor, or plain subversion or git repositories. This package\nis a lightweight replacement of the `install_*` functions in\n[`devtools`](https://github.com/r-lib/devtools).\nIndeed most of the code was copied over from `devtools`.\n\n## Features\n\n* Installers:\n  * Install packages with their dependencies.\n  * Install from GitHub, GitLab, Bitbucket.\n  * Install from git and subversion repositories.\n  * Install from local files or URLs.\n  * Install the dependencies of a local package tree.\n  * Install specific package versions from CRAN.\n* Supports [Bioconductor](https://bioconductor.org/) packages.\n* Supports the `Remotes` field in `DESCRIPTION`. See more in the\n  [dependencies](https://remotes.r-lib.org/articles/dependencies.html) vignette.\n* Supports the `Additional_repositories` field in `DESCRIPTION`.\n* Can install itself from GitHub (see below).\n* Does not depend on other R packages.\n* Does not contain compiled code, so no compiler is needed.\n* Does not need any external software (for most of the functionality\n  at least).\n\n## Installation\n\nInstall the released version of remotes from CRAN:\n\n```r\ninstall.packages(\"remotes\")\n```\n\n## Usage\n\nNote that most of the examples here use GitHub. See below for other\nsupported repository types.\n\nTo install the latest version of a package in the default branch from\nGitHub, you can use the `user/repo` form. Note that `user` can also be\nan organization:\n\n```r\nremotes::install_github(\"r-lib/conflicted\")\n```\n\nIf the R package is inside a subdirectory of the root directory,\nthen give this subdirectory as well:\n\n```r\n# build = FALSE because of some specificities of XGBoost package\ninstall_github(\"dmlc/xgboost/R-package\", build = FALSE)\n```\n\nTo install a certain branch or commit or tag, append it to the\nrepo name, after an `@`:\n\n```r\nremotes::install_github(\"gaborcsardi/pkgconfig@v2.0.0\")\n```\n\nTo install the latest release, append `@*release` to the repo\nname:\n\n```r\nremotes::install_github(\"gaborcsardi/pkgconfig@*release\")\n```\n\nTo install a pull request, append `#` and the id (an integer number)\nof the pull request to the repo name:\n\n```r\nremotes::install_github(\"r-lib/pkgconfig#7\")\n```\n\n### Dependencies\n\nDependencies are automatically installed from CRAN. By default,\noutdated dependencies are automatically upgraded. In interactive sessions\nyou can select a subset of the dependencies to upgrade.\n\n#### Dependencies on GitHub\n\nIt is also possible to install dependencies from GitHub or other\nsupported repositories. For this you need to add a `Remotes` field to the\n`DESCRIPTION` file. Its format is:\n```\nRemotes: [remote::]repo_spec, [remote::]repo_spec, ...\n```\nwhere `repo_spec` is any repository specification the corresponding\n`install_()` function can handle. If `remote::` is missing, `github::` is\nassumed. Other possible values: `gitlab::`,`bitbucket::`, `git::`, `local::`,\n`svn::`, `url::`, `version::`, `cran::`, `bioc::`.\n\nSee more about the `Remotes` field in this\n[vignette](https://remotes.r-lib.org/articles/dependencies.html).\n\n#### Additional repositories\n\nremotes supports the `Additional_repositories` field in\n`DESCRIPTION`. This is a way to specify dependencies from non-CRAN\npackage repositories. See the [Writing R extensions](https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Package-Dependencies)\nmanual for details.\n\n#### Bioconductor packages\n\nBioconductor packages are automatically detected and their\ndependencies are installed from Bioconductor.\n\n#### Currently supported remote types\n\n* GitHub repositories via `install_github`.\n* Bitbucket repositories via `install_bitbucket`.\n* Generic git repositories via `install_git`. They need either a\n  system git installation, or the\n  [git2r](https://github.com/ropensci/git2r) R package.\n* Local directories or package archive files via `install_local`.\n* Remote package archive files via `install_url`.\n* Packages in subversion repositories via `install_svn`. They need\n  a system subversion installation.\n* Specific package versions from CRAN or other CRAN-like\n  repositories via `install_version`. This includes outdated\n  and archived packages as well.\n* All dependencies of a package in a local directory via\n  `install_deps`.\n\n### Download methods\n\n* For R older than 3.2, the curl package is required as remotes falls back\n  to `curl::curl_download` in that case\n* For R newer than 3.3, default `download.file()` method is used.\n  (`method = \"auto\"`)\n* For in between versions,\n    * `method = \"wininet\"` is used on windows OS\n    * `method = \"libcurl\"` is used on other OS, if available.\n\nSee `help(\"download.file\")` for information on these methods and for\nsetting proxies if needed.\n\n### Standalone mode\n\nremotes will use the curl, git2r and pkgbuild packages if they are\ninstalled to provide faster implementations for some aspects of the install\nprocess. However if you are using remotes to install or update these packages\n(or their reverse dependencies) using them during installation may fail\n(particularly on Windows).\n\nIf you set the environment variable `R_REMOTES_STANDALONE=\"true\"` (e.g.\nin R `Sys.setenv(R_REMOTES_STANDALONE=\"true\")`) you can force remotes to\noperate in standalone mode and use only its internal R implementations. This\nwill allow successful installation of these packages.\n\n### Options\n\nremotes uses the following standard R options, see `?options` for their\ndetails:\n\n* `download.file.method` for the default download method. See\n  `?download.file`.\n\n* `pkgType` for the package type (source or binary, see manual) to install,\n  download or look up dependencies for.\n\n* `repos` for the locations of the user's standard CRAN(-like) repositories.\n\nIt also uses some remotes specific options:\n\n* `BioC_git` for the URL of the default Bioconductor git mirror.\n\n* `BioC_mirror` for the URL of the Bioconductor mirror.\n\n* `unzip` for the path of the external `unzip` program.\n\n### Environment variables\n\n* The `BITBUCKET_USER` and `BITBUCKET_PASSWORD` environment variables\n  are used for the default Bitbucket  user name and password, in\n  `install_bitbucket()`\n\n* The `GITHUB_PAT` environment variable is used as the default GitHub\n  personal access token for all GitHub API queries.\n\n* The `R_BIOC_MIRROR` environment variable can be used to specify an\n  alternative Bioconductor mirror. (The `BioC_mirror` option takes\n  precedence over this.)\n\n* The `R_BIOC_VERSION` environment variable can be used to force a\n  Bioconductor version.\n\n* The `R_REMOTES_UPGRADE` environment variable can be used to set a default\n  preferred value for the `upgrade =` argument accepted by the various\n  `install_*()` functions. For example, you can set `R_REMOTES_UPGRADE=\"always\"`\n  to upgrade dependent packages without asking the user.\n\n* Setting `R_REMOTES_STANDALONE=\"true\"` forces remotes to work in standalone\n  mode and avoid loading its optional dependencies (curl, git2 and pkgbuild\n  currently. See \"Standalone mode\" above.\n\n* Setting `R_REMOTES_NO_ERRORS_FROM_WARNINGS=\"false\"` will cause warning\n  messages during calls to `install.packages()` to become errors. Often warning\n  messages are caused by dependencies failing to install.\n\n## License\n\nGPL (\u003e= 2) © Ascent Digital Services, Posit Software, PBC\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lib%2Fremotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr-lib%2Fremotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lib%2Fremotes/lists"}