diff --git a/404.html b/404.html index 002a9255..5b7561c4 100644 --- a/404.html +++ b/404.html @@ -4,91 +4,112 @@ - + Page not found (404) • remotes - - - - - + + + - + + + - - Skip to content + -
-
-
-

Page not found (404)

+ +
+ + + +
+
+
+

Page not found (404)

Content not found. Please use links in the navbar. -
+
+ + +
+ + - - + + + + + + + + diff --git a/LICENSE-text.html b/LICENSE-text.html index 02d90bae..06612e1c 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,71 +1,89 @@ -License • remotesLicense • remotes - Skip to content + -
-
-
-

License

+ +
+
+
+

License

YEAR: 2021
 COPYRIGHT HOLDER: remotes authors
-
+
+ - - + + + + + + + + diff --git a/LICENSE.html b/LICENSE.html index cab8f471..6d40c850 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,53 +1,59 @@ -MIT License • remotesMIT License • remotes - Skip to content + -
-
-
-

MIT License

- Source: LICENSE.md + + +
+
+
+

MIT License

@@ -58,18 +64,30 @@

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-
+
+ - - + + + + + + + + diff --git a/MAINTENANCE.html b/MAINTENANCE.html index d204f62d..5c97249c 100644 --- a/MAINTENANCE.html +++ b/MAINTENANCE.html @@ -1,53 +1,59 @@ -NA • remotesNA • remotes - Skip to content + -
-
-
-

NA

- Source: MAINTENANCE.md + + +
+
+
+

NA

@@ -69,19 +75,30 @@

Future directions

+
+ -
- +
+ + + + + + + diff --git a/articles/dependencies.html b/articles/dependencies.html index 94aa3375..f31cd765 100644 --- a/articles/dependencies.html +++ b/articles/dependencies.html @@ -4,83 +4,90 @@ - - + Dependency resolution for R package development • remotes - - - - - + + + - + + + - - Skip to content + -
- - + +
+ + -
-
-

Dependency resolution for R package development

+
+
+
+

Dependency resolution for R package +development

Jim Hester, Hadley Wickham, Gábor Csárdi

-

2023-02-21

+

2023-11-03

Source: vignettes/dependencies.Rmd -
dependencies.Rmd
+ +
@@ -158,24 +165,35 @@

CRAN submissionRemotes field.

-
+
+ + +
- - + + + + + + + + diff --git a/articles/index.html b/articles/index.html index 40785af8..77a268a3 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,52 +1,59 @@ -Articles • remotesArticles • remotes - Skip to content + -
-
-
-

Articles

+ + +
+
+
+

Articles

@@ -56,18 +63,24 @@

All vignettes

Dependency resolution for R package development
-
+
+ - - + + + + + + + diff --git a/authors.html b/authors.html index c22dacdd..688e6f46 100644 --- a/authors.html +++ b/authors.html @@ -1,59 +1,65 @@ -Authors and Citation • remotesAuthors and Citation • remotes - Skip to content + -
-
-
-

Authors and Citation

-
+ + +
+
+
+
+

Authors

+
-
-

Authors

  • -

    Gábor Csárdi. Author, maintainer. +

    Gábor Csárdi. Author, maintainer.

  • @@ -61,23 +67,23 @@

    Authors

  • -

    Hadley Wickham. Author. +

    Hadley Wickham. Author.

  • -

    Winston Chang. Author. +

    Winston Chang. Author.

  • -

    RStudio. Copyright holder. +

    Martin Morgan. Author.

  • -

    Martin Morgan. Author. +

    Dan Tenenbaum. Author.

  • -

    Dan Tenenbaum. Author. +

    Posit Software, PBC. Copyright holder, funder.

  • @@ -85,35 +91,46 @@

    Authors

+
+
+

Citation

+ Source: DESCRIPTION +
+
-
-

Citation

-

Source: DESCRIPTION

-

Csárdi G, Hester J, Wickham H, Chang W, Morgan M, Tenenbaum D (2023). +

Csárdi G, Hester J, Wickham H, Chang W, Morgan M, Tenenbaum D (2023). remotes: R Package Installation from Remote Repositories, Including 'GitHub'. -https://remotes.r-lib.org, https://github.com/r-lib/remotes#readme. +R package version 2.4.2, https://github.com/r-lib/remotes#readme, https://remotes.r-lib.org.

- 
@Manual{,
+    
@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 = {2023},
-  note = {https://remotes.r-lib.org, https://github.com/r-lib/remotes#readme},
+  note = {R package version 2.4.2, https://github.com/r-lib/remotes#readme},
+  url = {https://remotes.r-lib.org},
 }

-
-
+ +
+ + + - - + + + + + + + diff --git a/index.html b/index.html index 51a93cb4..76efeccf 100644 --- a/index.html +++ b/index.html @@ -4,19 +4,14 @@ - - + R Package Installation from Remote Repositories, Including GitHub • remotes - - - - - + + + - + + + - - Skip to content - - -
-
-
+ +
+ + + + +
+
+

remotes

@@ -229,7 +235,10 @@

LicenseGPL (>= 2) © Mango Solutions, RStudio

-
+
- - + + + + + + + + diff --git a/news/index.html b/news/index.html index 4d5c3554..4b134fea 100644 --- a/news/index.html +++ b/news/index.html @@ -1,64 +1,71 @@ -Changelog • remotesChangelog • remotes - Skip to content + -
-
-
-

Changelog

+ + +
+
+
+

Changelog

Source: NEWS.md
-

remotes 2.4.2

CRAN release: 2021-11-30

+

remotes 2.4.22021-11-30

  • Gábor Csárdi is now the maintainer.
  • bioc_version() now points to the most recent (2021-10-27) Bioconductor release, v3.14 (@stufield, #664).
  • Fix regex to handle user names in URL in git_remote, add regression tests (@achimgaedke, #646).
-

remotes 2.4.1

CRAN release: 2021-09-29

+

remotes 2.4.12021-09-29

  • pkgbuild is no longer accidentally loaded even in standalone mode (#548)
  • The internal GitHub token used to increase rate limits has been regenerated.
  • Using remote_package_name.git2r_remote now passes credentials when looking up the package DESCRIPTION (#633, @rnorberg)
    • @@ -67,7 +74,7 @@

    remotes 2.4.1Clarify github_pull() documentation (@ms609 #640).

-

remotes 2.4.0

CRAN release: 2021-06-02

+

remotes 2.4.02021-06-02

-

remotes 2.3.0

CRAN release: 2021-04-01

+

remotes 2.3.02021-04-01

Major changes

  • @@ -93,7 +100,7 @@

    Minor improvements and fixes

-

remotes 2.2.0

CRAN release: 2020-07-21

+

remotes 2.2.02020-07-21

New functions and features

  • New system_requirements() function to query the Public RStudio Package Manager for system requirements for a package (and its dependencies)

    • @@ -115,7 +122,7 @@

    Minor improvements and fixes

-

remotes 2.1.1

CRAN release: 2020-02-15

+

remotes 2.1.12020-02-15

Minor improvements and fixes

  • Installing mixed binary and source dependencies when the latest versions of some packages do not have binaries yet should now install dependencies in the correct order to prevent load failures (#296)

    • @@ -128,7 +135,7 @@

    Minor improvements and fixes

-

remotes 2.1.0

CRAN release: 2019-06-24

+

remotes 2.1.02019-06-24

New features

  • install_*() functions gain build_manual and build_vignette arguments that previously existed in devtools versions < 2.0 (#353).

    • @@ -159,14 +166,14 @@

    Minor improvements and fixes

-

remotes 2.0.4

CRAN release: 2019-04-10

+

remotes 2.0.42019-04-10

  • update.package_dependencies() now uses the pkg_type for the cran remote rather than a global type attribute, fixing errors when this global attribute is lost (#291, #304).

  • Credentials are no longer passed to dependencies, as this breaks dependencies which use different credentials or hosts. If you have relied on this behavior a more robust way to provide the credentials is using the appropriate environment variables, e.g. GITHUB_PAT, BITBUCKET_USER etc. (@antoine-sachet, #345).

  • The hash of bitbucket hosts is now correctly retrieved (@antoine-sachet, #344)

  • Fix parsing of Additional_Repositories which have a leading newline (@tmelliott, #251).

-

remotes 2.0.3

CRAN release: 2019-04-09

+

remotes 2.0.32019-04-09

-

remotes 2.0.2

CRAN release: 2018-10-30

+

remotes 2.0.22018-10-30

  • install_deps() now installs un-installed remotes packages even when upgrade = "never" (@ankane, #227)

  • install_version() now removes metadata added as a byproduct of using install_url() internally() (#224)

  • install() now avoids converting warnings to errors if R_REMOTES_NO_ERRORS_FROM_WARNINGS is unset and _R_CHECK_FORCE_SUGGESTS_=false. This avoids failures due to Suggested packages potentially being missing.

    • @@ -192,7 +199,7 @@

    remotes 2.0.2

    install_deps() now installs un-installed packages even when upgrade = "never" (#218)

-

remotes 2.0.1

CRAN release: 2018-10-19

+

remotes 2.0.12018-10-19

  • install_github() now bundles a GitHub PAT which is used on Travis to avoid hitting the rate limit too frequently. It also contains a more informative error message when the rate limit is hit on how to setup a GitHub personal access token.

  • The dialog when upgrade = "ask" now has a ‘CRAN only’ option, to update only CRAN packages.

  • No longer include project specific .Rprofile code in the temporary .Rprofile when R_REMOTES_NO_ERRORS_FROM_WARNINGS=false (the default).

    • @@ -200,7 +207,7 @@

    remotes 2.0.1

    available_packages(), available_packages_set() and available_packges_reset() added to allow caching of the available.packages() database.

-

remotes 2.0.0

CRAN release: 2018-10-11

+

remotes 2.0.02018-10-11

Breaking changes

  • install_github()’s previously deprecated username argument has been removed. (#142)

    • @@ -242,11 +249,11 @@

    Minor improvements and fixes

-

remotes 1.1.1

CRAN release: 2017-12-20

+

remotes 1.1.12017-12-20

  • Accept HTTPS, SSH, or various browser URLs in GitHub repo specification, @jennybc, #90, #109, #112
-

remotes 1.1.0

CRAN release: 2017-07-09

+

remotes 1.1.02017-07-09

-

remotes 1.0.0

CRAN release: 2016-09-10

+

remotes 1.0.02016-09-10

First public release.

-
+
+ - - + + + + + + + + diff --git a/pkgdown.js b/pkgdown.js index 5fccd9c0..6f0eee40 100644 --- a/pkgdown.js +++ b/pkgdown.js @@ -2,30 +2,70 @@ (function($) { $(function() { - $('nav.navbar').headroom(); + $('.navbar-fixed-top').headroom(); - Toc.init({ - $nav: $("#toc"), - $scope: $("main h2, main h3, main h4, main h5, main h6") + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); }); - if ($('#toc').length) { - $('body').scrollspy({ - target: '#toc', - offset: $("nav.navbar").outerHeight() + 1 - }); + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } } - // Activate popovers - $('[data-bs-toggle="popover"]').popover({ - container: 'body', - html: true, - trigger: 'focus', - placement: "top", - sanitize: false, - }); + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); - $('[data-bs-toggle="tooltip"]').tooltip(); + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } /* Clipboard --------------------------*/ @@ -38,7 +78,7 @@ if(ClipboardJS.isSupported()) { $(document).ready(function() { - var copyButton = ""; + var copyButton = ""; $("div.sourceCode").addClass("hasCopyButton"); @@ -49,108 +89,20 @@ $('.btn-copy-ex').tooltip({container: 'body'}); // Initialize clipboard: - var clipboard = new ClipboardJS('[data-clipboard-copy]', { + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); - clipboard.on('success', function(e) { + clipboardBtnCopies.on('success', function(e) { changeTooltipMessage(e.trigger, 'Copied!'); e.clearSelection(); }); - clipboard.on('error', function() { + clipboardBtnCopies.on('error', function() { changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); }); - }); } - - /* Search marking --------------------------*/ - var url = new URL(window.location.href); - var toMark = url.searchParams.get("q"); - var mark = new Mark("main#main"); - if (toMark) { - mark.mark(toMark, { - accuracy: { - value: "complementary", - limiters: [",", ".", ":", "/"], - } - }); - } - - /* Search --------------------------*/ - /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ - // Initialise search index on focus - var fuse; - $("#search-input").focus(async function(e) { - if (fuse) { - return; - } - - $(e.target).addClass("loading"); - var response = await fetch($("#search-input").data("search-index")); - var data = await response.json(); - - var options = { - keys: ["what", "text", "code"], - ignoreLocation: true, - threshold: 0.1, - includeMatches: true, - includeScore: true, - }; - fuse = new Fuse(data, options); - - $(e.target).removeClass("loading"); - }); - - // Use algolia autocomplete - var options = { - autoselect: true, - debug: true, - hint: false, - minLength: 2, - }; - var q; -async function searchFuse(query, callback) { - await fuse; - - var items; - if (!fuse) { - items = []; - } else { - q = query; - var results = fuse.search(query, { limit: 20 }); - items = results - .filter((x) => x.score <= 0.75) - .map((x) => x.item); - if (items.length === 0) { - items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}]; - } - } - callback(items); -} - $("#search-input").autocomplete(options, [ - { - name: "content", - source: searchFuse, - templates: { - suggestion: (s) => { - if (s.title == s.what) { - return `${s.dir} >
    ${s.title}
    `; - } else if (s.previous_headings == "") { - return `${s.dir} >
    ${s.title}
    > ${s.what}`; - } else { - return `${s.dir} >
    ${s.title}
    > ${s.previous_headings} > ${s.what}`; - } - }, - }, - }, - ]).on('autocomplete:selected', function(event, s) { - window.location.href = s.path + "?q=" + q + "#" + s.id; - }); - }); })(window.jQuery || window.$) - - diff --git a/pkgdown.yml b/pkgdown.yml index ff1655f0..c63f2a3a 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.7 pkgdown_sha: ~ articles: dependencies: dependencies.html -last_built: 2023-02-21T17:44Z +last_built: 2023-11-03T15:28Z urls: reference: https://remotes.r-lib.org/reference article: https://remotes.r-lib.org/articles diff --git a/reference/available_packages.html b/reference/available_packages.html index 2a969146..1d3c3222 100644 --- a/reference/available_packages.html +++ b/reference/available_packages.html @@ -1,68 +1,72 @@ -Simpler available.packages — available_packages_set • remotesSimpler available.packages — available_packages_set • remotes - Skip to content - - -
    -
    -
    -

    Simpler available.packages

    - Source: R/cran.R -
    available_packages.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Simpler available.packages

    + Source: R/cran.R +
    -
    +

    This is mostly equivalent to utils::available.packages() however it also caches the full result. Additionally the cache can be assigned explicitly with available_packages_set() and reset (cleared) with available_packages_reset().

    -
    -

    Usage

    + 
    available_packages_set(repos, type, db)
 
 available_packages_reset()
@@ -70,8 +74,8 @@ 
    Usage
 available_packages(repos = getOption("repos"), type = getOption("pkgType"))
    -
    -

    Arguments

    +
    +

    Arguments

    repos

    character vector, the base URL(s) of the repositories to use.

    @@ -82,24 +86,32 @@

    Arguments this will use the source repository.

    -
    -

    See also

    +
    +

    See also

    utils::available.packages() for full documentation on the output format.

    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/bioc_install_repos.html b/reference/bioc_install_repos.html index 36d9f55a..6fd9b767 100644 --- a/reference/bioc_install_repos.html +++ b/reference/bioc_install_repos.html @@ -1,72 +1,77 @@ -Tools for Bioconductor repositories — bioc_version • remotesTools for Bioconductor repositories — bioc_version • remotes - Skip to content + -
    -
    -
    -

    Tools for Bioconductor repositories

    - Source: R/bioc.R -
    bioc_install_repos.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Tools for Bioconductor repositories

    + Source: R/bioc.R +
    -
    +

    bioc_version() returns the Bioconductor version for the current or the specified R version.

    -
    -

    Usage

    + 
    bioc_version(r_ver = getRversion())
 
 bioc_install_repos(r_ver = getRversion(), bioc_ver = bioc_version(r_ver))
    -
    -

    Arguments

    +
    +

    Arguments

    r_ver

    R version to use. For bioc_install_repos() it is ignored if bioc_ver is specified.

    @@ -77,8 +82,8 @@

    Arguments -

    Value

    +
    +

    Value

    bioc_version() returns a Bioconductor version, a package_version

    @@ -91,8 +96,8 @@

    Value

    -
    -

    Details

    +
    +

    Details

    bioc_install_repos() deduces the URLs of the Bioconductor repositories.

    Both functions observe the R_BIOC_VERSION environment variable, which can be set to force a Bioconductor version. If this is set, then the @@ -103,38 +108,46 @@

    Detailshttps://bioconductor.org.

    -
    -

    Examples

    +
    +

    Examples

    bioc_version()
-#> [1] ‘3.16’
+#> [1] ‘3.18’
 bioc_version("3.4")
 #> [1] ‘3.6’
 bioc_install_repos()
 #>                                                 BioCsoft 
-#>            "https://bioconductor.org/packages/3.16/bioc" 
+#>            "https://bioconductor.org/packages/3.18/bioc" 
 #>                                                  BioCann 
-#> "https://bioconductor.org/packages/3.16/data/annotation" 
+#> "https://bioconductor.org/packages/3.18/data/annotation" 
 #>                                                  BioCexp 
-#> "https://bioconductor.org/packages/3.16/data/experiment" 
+#> "https://bioconductor.org/packages/3.18/data/experiment" 
 #>                                            BioCworkflows 
-#>       "https://bioconductor.org/packages/3.16/workflows" 
+#>       "https://bioconductor.org/packages/3.18/workflows" 
 #>                                                BioCbooks 
-#>           "https://bioconductor.org/packages/3.16/books" 
+#>           "https://bioconductor.org/packages/3.18/books"
    -
    +
    + +

    -
    -
    + + + + + + + diff --git a/reference/download.html b/reference/download.html index 7146a729..805b559d 100644 --- a/reference/download.html +++ b/reference/download.html @@ -1,65 +1,70 @@ -Download a file — download • remotesDownload a file — download • remotes - Skip to content + -
    -
    -
    -

    Download a file

    - Source: R/download.R -
    download.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Download a file

    + Source: R/download.R +
    -
    +

    Uses either the curl package for R versions older than 3.2.0, otherwise a wrapper around download.file().

    -
    -

    Usage

    + 
    download(
   path,
   url,
@@ -70,8 +75,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    path

    Path to download to. dirname(path) must exist.

    @@ -97,14 +102,14 @@

    Arguments -

    Value

    +
    +

    Value

    path, if the download was successful.

    -
    -

    Details

    +
    +

    Details

    We respect the download.file.method setting of the user. If it is not set, then see download_method() for choosing a method.

    Authentication can be supplied three ways:

    • By setting auth_token. This will append an HTTP Authorization @@ -119,19 +124,27 @@

      Detailsheaders.

    -
    +

    + +
    -
    -
    + + + + + + + diff --git a/reference/download_version.html b/reference/download_version.html index 936c79dd..3f2ef369 100644 --- a/reference/download_version.html +++ b/reference/download_version.html @@ -1,65 +1,70 @@ -Download a specified version of a CRAN package — download_version • remotesDownload a specified version of a CRAN package — download_version • remotes - Skip to content + -
    -
    -
    -

    Download a specified version of a CRAN package

    - Source: R/install-version.R -
    download_version.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Download a specified version of a CRAN package

    + Source: R/install-version.R +
    -
    +

    It downloads the package to a temporary file, and returns the name of the file.

    -
    -

    Usage

    + 
    download_version(
   package,
   version = NULL,
@@ -69,8 +74,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    package

    Name of the package to install.

    @@ -104,26 +109,34 @@

    Argumentsutils::install.packages().

    -
    -

    Value

    +
    +

    Value

    Name of the downloaded file.

    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/git_credentials.html b/reference/git_credentials.html index b6ea7f25..42270a61 100644 --- a/reference/git_credentials.html +++ b/reference/git_credentials.html @@ -1,81 +1,95 @@ -Specify git credentials to use — git_credentials • remotesSpecify git credentials to use — git_credentials • remotes - Skip to content + -
    -
    -
    -

    Specify git credentials to use

    - Source: R/install-git.R -
    git_credentials.Rd
    + + +
    +
    +
    +

    Specify git credentials to use

    + Source: R/install-git.R +
    -
    +

    The global option remotes.git_credentials is used to set the git credentials.

    -
    -

    Usage

    + 
    git_credentials()
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/github_refs.html b/reference/github_refs.html index cf288c0b..b2e83bdc 100644 --- a/reference/github_refs.html +++ b/reference/github_refs.html @@ -1,102 +1,115 @@ -GitHub references — github_pull • remotesGitHub references — github_pull • remotes - Skip to content + -
    -
    -
    -

    GitHub references

    - Source: R/install-github.R -
    github_refs.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    GitHub references

    + Source: R/install-github.R +
    -
    +

    Use as ref parameter to install_github(). Allows installing a specific pull request or the latest release.

    -
    -

    Usage

    + 
    github_pull(pull)
 
 github_release()
    -
    -

    Arguments

    +
    +

    Arguments

    pull

    Character string specifying the pull request to install

    -
    -

    See also

    +
    +

    See also

    install_github()

    -
    -

    Examples

    +
    +

    Examples

    github_pull("42")
 #> [1] "42"
 #> attr(,"class")
 #> [1] "github_pull"
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/github_remote.html b/reference/github_remote.html index cf1f9624..02a17a9e 100644 --- a/reference/github_remote.html +++ b/reference/github_remote.html @@ -1,65 +1,70 @@ -Create a new github_remote — github_remote • remotesCreate a new github_remote — github_remote • remotes - Skip to content + -
    -
    -
    -

    Create a new github_remote

    - Source: R/install-github.R -
    github_remote.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Create a new github_remote

    + Source: R/install-github.R +
    -
    +

    This is an internal function to create a new github_remote, users should generally have no need for it.

    -
    -

    Usage

    + 
    github_remote(
   repo,
   ref = "HEAD",
@@ -71,8 +76,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    repo

    Repository address in the format username/repo[/subdir][@ref|#pull|@*release]. Alternatively, you can @@ -112,19 +117,27 @@

    Arguments

    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/gitlab_pat.html b/reference/gitlab_pat.html index c77b490a..3dd925b7 100644 --- a/reference/gitlab_pat.html +++ b/reference/gitlab_pat.html @@ -1,81 +1,95 @@ -Retrieve GitLab personal access token. — gitlab_pat • remotesRetrieve GitLab personal access token. — gitlab_pat • remotes - Skip to content + -
    -
    -
    -

    Retrieve GitLab personal access token.

    - Source: R/install-gitlab.R -
    gitlab_pat.Rd
    + + +
    +
    +
    +

    Retrieve GitLab personal access token.

    + Source: R/install-gitlab.R +
    -
    +

    A GitLab personal access token Looks in env var GITLAB_PAT

    -
    -

    Usage

    + 
    gitlab_pat(quiet = TRUE)
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/index.html b/reference/index.html index eea545b0..28ca2af4 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,191 +1,167 @@ -Function reference • remotesFunction reference • remotes - Skip to content + -
    -
    -
    -

    Function reference

    -
    - -
    -

    Package Installation

    -

    Tools for installing packages from a variety of locations.

    - -
    - - - +
    +
    +
    +

    Reference

    +
    -
    - - install_bioc() -
    -
    Install a development package from the Bioconductor git repository
    -
    - - install_bitbucket() -
    -
    Install a package directly from Bitbucket
    -
    - - install_cran() -
    -
    Attempts to install a package from CRAN.
    -
    - - install_dev() -
    -
    Install the development version of a package
    -
    - - install_git() -
    -
    Install a package from a git repository
    -
    - - install_github() -
    -
    Attempts to install a package directly from GitHub.
    -
    - - install_gitlab() -
    -
    Install a package from GitLab
    -
    - - install_local() -
    -
    Install a package from a local file
    -
    - - install_svn() -
    -
    Install a package from a SVN repository
    -
    - - install_url() -
    -
    Install a package from a url
    -
    - - install_version() -
    -
    Install specific version of a package.
    -
    - - download_version() -
    -
    Download a specified version of a CRAN package
    -
    - - update_packages() -
    -
    Update packages that are missing or out-of-date.
    -
    - - system_requirements() -
    -
    Query the system requirements for a package (and its dependencies)
    -
    -

    Dependencies

    - -

    Tools for working with package dependencies.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    Package Installation

    +

    Tools for installing packages from a variety of locations.

    +
    +

    install_bioc()

    +

    Install a development package from the Bioconductor git repository

    +

    install_bitbucket()

    +

    Install a package directly from Bitbucket

    +

    install_cran()

    +

    Attempts to install a package from CRAN.

    +

    install_dev()

    +

    Install the development version of a package

    +

    install_git()

    +

    Install a package from a git repository

    +

    install_github()

    +

    Attempts to install a package directly from GitHub.

    +

    install_gitlab()

    +

    Install a package from GitLab

    +

    install_local()

    +

    Install a package from a local file

    +

    install_svn()

    +

    Install a package from a SVN repository

    +

    install_url()

    +

    Install a package from a url

    +

    install_version()

    +

    Install specific version of a package.

    +

    download_version()

    +

    Download a specified version of a CRAN package

    +

    update_packages()

    +

    Update packages that are missing or out-of-date.

    +

    system_requirements()

    +

    Query the system requirements for a package (and its dependencies)

    +

    Dependencies

    +

    Tools for working with package dependencies.

    +
    +

    install_deps()

    +

    Install package dependencies if needed.

    +

    package_deps() local_package_deps() dev_package_deps() update(<package_deps>)

    +

    Find all dependencies of a CRAN or dev package.

    +

    GitHub helpers

    +

    Utilities for interacting with GitHub.

    +
    +

    github_pull() github_release()

    +

    GitHub references

    +

    parse_repo_spec() parse_github_repo_spec() parse_github_url()

    +

    Parse a remote git repo specification

    + + +
    - -
    - - - -
    - - install_deps() -
    -
    Install package dependencies if needed.
    -
    - - package_deps() local_package_deps() dev_package_deps() update(<package_deps>) -
    -
    Find all dependencies of a CRAN or dev package.
    -
    -

    GitHub helpers

    - -

    Utilities for interacting with GitHub.

    +
    +

    Developed by Gábor Csárdi, Jim Hester, Hadley Wickham, Winston Chang, Martin Morgan, Dan Tenenbaum, Posit Software, PBC.

    +
    - -
    - - - +
    +

    Site built with pkgdown 2.0.7.

    +
    -
    - - github_pull() github_release() -
    -
    GitHub references
    -
    - - parse_repo_spec() parse_github_repo_spec() parse_github_url() -
    -
    Parse a remote git repo specification
    -
    -
    +
    + -
    - + diff --git a/reference/install_bioc.html b/reference/install_bioc.html index 9f2230fe..ce03b15d 100644 --- a/reference/install_bioc.html +++ b/reference/install_bioc.html @@ -1,65 +1,70 @@ -Install a development package from the Bioconductor git repository — install_bioc • remotesInstall a development package from the Bioconductor git repository — install_bioc • remotes - Skip to content + -
    -
    -
    -

    Install a development package from the Bioconductor git repository

    - Source: R/install-bioc.R -
    install_bioc.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a development package from the Bioconductor git repository

    + Source: R/install-bioc.R +
    -
    +

    This function requires git to be installed on your system in order to be used.

    -
    -

    Usage

    + 
    install_bioc(
   repo,
   mirror = getOption("BioC_git", download_url("git.bioconductor.org/packages")),
@@ -78,8 +83,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    repo

    Repository address in the format [username:password@][release/]repo[#commit]. Valid values for @@ -159,16 +164,16 @@

    Argumentsutils::install.packages().

    -
    -

    Details

    +
    +

    Details

    It is vectorised so you can install multiple packages with a single command.

    This is intended as an aid for Bioconductor developers. If you want to install the release version of a Bioconductor package one can use the BiocManager package.

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bitbucket(), install_cran(), @@ -182,8 +187,8 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_bioc("SummarizedExperiment")
 install_bioc("devel/SummarizedExperiment")
@@ -195,19 +200,27 @@ 
    Examples}
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_bitbucket.html b/reference/install_bitbucket.html index 2af0b91d..022b3034 100644 --- a/reference/install_bitbucket.html +++ b/reference/install_bitbucket.html @@ -1,65 +1,70 @@ -Install a package directly from Bitbucket — install_bitbucket • remotesInstall a package directly from Bitbucket — install_bitbucket • remotes - Skip to content + -
    -
    -
    -

    Install a package directly from Bitbucket

    - Source: R/install-bitbucket.R -
    install_bitbucket.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a package directly from Bitbucket

    + Source: R/install-bitbucket.R +
    -
    +

    This function is vectorised so you can install multiple packages in a single command.

    -
    -

    Usage

    + 
    install_bitbucket(
   repo,
   ref = "HEAD",
@@ -81,8 +86,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    repo

    Repository address in the format username/repo[/subdir][@ref]. Alternatively, you can @@ -179,8 +184,8 @@

    Argumentsutils::install.packages().

    -
    -

    Details

    +
    +

    Details

    To install from a private repo, or more generally, access the Bitbucket API with your own credentials, you will need to get an access token. You can create an access token following the instructions found in @@ -199,8 +204,8 @@

    Detailsnot set the system proxies automatically, see "Setting Proxies" in utils::download.file().

    -
    -

    See also

    +
    +

    See also

    Bitbucket API docs: https://confluence.atlassian.com/bitbucket/use-the-bitbucket-cloud-rest-apis-222724129.html

    Other package installation: @@ -216,27 +221,35 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_bitbucket("sulab/mygene.r@default")
 install_bitbucket("djnavarro/lsr")
 }
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_cran.html b/reference/install_cran.html index 963272cd..96d62a0f 100644 --- a/reference/install_cran.html +++ b/reference/install_cran.html @@ -1,65 +1,70 @@ -Attempts to install a package from CRAN. — install_cran • remotesAttempts to install a package from CRAN. — install_cran • remotes - Skip to content + -
    -
    -
    -

    Attempts to install a package from CRAN.

    - Source: R/install-cran.R -
    install_cran.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Attempts to install a package from CRAN.

    + Source: R/install-cran.R +
    -
    +

    This function is vectorised on pkgs so you can install multiple packages in a single command.

    -
    -

    Usage

    + 
    install_cran(
   pkgs,
   repos = getOption("repos"),
@@ -76,8 +81,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    pkgs

    A character vector of packages to install.

    @@ -143,8 +148,8 @@

    Argumentsutils::install.packages().

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -158,27 +163,35 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_cran("ggplot2")
 install_cran(c("httpuv", "shiny"))
 }
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_deps.html b/reference/install_deps.html index 326e30c8..ad678662 100644 --- a/reference/install_deps.html +++ b/reference/install_deps.html @@ -1,62 +1,68 @@ -Install package dependencies if needed. — install_deps • remotesInstall package dependencies if needed. — install_deps • remotes - Skip to content + -
    -
    -
    -

    Install package dependencies if needed.

    - Source: R/install.R -
    install_deps.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install package dependencies if needed.

    + Source: R/install.R +
    -
    +

    Install package dependencies if needed.

    -
    -

    Usage

    + 
    install_deps(
   pkgdir = ".",
   dependencies = NA,
@@ -72,8 +78,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    pkgdir

    Path to a package directory, or to a package tarball.

    @@ -135,24 +141,32 @@

    Arguments -

    Examples

    +
    +

    Examples

    if (FALSE) install_deps(".")
    -

    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_dev.html b/reference/install_dev.html index 779e2b07..ceae48e2 100644 --- a/reference/install_dev.html +++ b/reference/install_dev.html @@ -1,76 +1,79 @@ -Install the development version of a package — install_dev • remotesInstall the development version of a package — install_dev • remotes - Skip to content - - -
    -
    -
    -

    Install the development version of a package

    - Source: R/install-dev.R -
    install_dev.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install the development version of a package

    + Source: R/install-dev.R +
    -
    +

    install_dev() retrieves the package DESCRIPTION from the CRAN mirror and looks in the 'URL' and 'BugReports' fields for GitHub, GitLab or Bitbucket URLs. It then calls the appropriate install_() function to install the development package.

    -
    -

    Usage

    + 
    install_dev(package, cran_url = getOption("repos")[["CRAN"]], ...)
    -
    -

    Arguments

    +
    +

    Arguments

    package

    The package name to install.

    @@ -85,8 +88,8 @@

    Argumentsinstall_gitlab(), or install_bitbucket() functions.

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -100,8 +103,8 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 # From GitHub
 install_dev("dplyr")
@@ -114,19 +117,27 @@ 
    Examples}
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_git.html b/reference/install_git.html index 9cce8e3b..6e2d5abb 100644 --- a/reference/install_git.html +++ b/reference/install_git.html @@ -1,68 +1,72 @@ -Install a package from a git repository — install_git • remotesInstall a package from a git repository — install_git • remotes - Skip to content - - -
    -
    -
    -

    Install a package from a git repository

    - Source: R/install-git.R -
    install_git.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a package from a git repository

    + Source: R/install-git.R +
    -
    +

    It is vectorised so you can install multiple packages with a single command. You do not need to have the git2r package, or an external git client installed.

    -
    -

    Usage

    + 
    install_git(
   url,
   subdir = NULL,
@@ -84,8 +88,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    url

    Location of package. The url should point to a public or private repository.

    @@ -176,14 +180,14 @@

    Argumentsutils::install.packages().

    -
    -

    Details

    +
    +

    Details

    If you need to set git credentials for use in the Remotes field you can do so by placing the credentials in the remotes.git_credentials global option.

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -197,27 +201,35 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_git("https://github.com/hadley/stringr.git")
 install_git("https://github.com/hadley/stringr.git", ref = "stringr-0.2")
 }
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_github.html b/reference/install_github.html index a2f1e4b1..bbbf93e0 100644 --- a/reference/install_github.html +++ b/reference/install_github.html @@ -1,65 +1,70 @@ -Attempts to install a package directly from GitHub. — install_github • remotesAttempts to install a package directly from GitHub. — install_github • remotes - Skip to content + -
    -
    -
    -

    Attempts to install a package directly from GitHub.

    - Source: R/install-github.R -
    install_github.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Attempts to install a package directly from GitHub.

    + Source: R/install-github.R +
    -
    +

    This function is vectorised on repo so you can install multiple packages in a single command.

    -
    -

    Usage

    + 
    install_github(
   repo,
   ref = "HEAD",
@@ -80,8 +85,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    repo

    Repository address in the format username/repo[/subdir][@ref|#pull|@*release]. Alternatively, you can @@ -177,13 +182,13 @@

    Argumentsutils::install.packages().

    -
    -

    Details

    +
    +

    Details

    If the repository uses submodules a command-line git client is required to clone the submodules.

    -
    -

    See also

    +
    +

    See also

    github_pull()

    Other package installation: install_bioc(), @@ -198,23 +203,31 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_gitlab.html b/reference/install_gitlab.html index 1a17cdc2..f8883f52 100644 --- a/reference/install_gitlab.html +++ b/reference/install_gitlab.html @@ -1,71 +1,74 @@ -Install a package from GitLab — install_gitlab • remotesInstall a package from GitLab — install_gitlab • remotes - Skip to content - - -
    -
    -
    -

    Install a package from GitLab

    - Source: R/install-gitlab.R -
    install_gitlab.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a package from GitLab

    + Source: R/install-gitlab.R +
    -
    +

    This function is vectorised on repo so you can install multiple packages in a single command. Like other remotes the repository will skip installation if force == FALSE (the default) and the remote state has not changed since the previous installation.

    -
    -

    Usage

    + 
    install_gitlab(
   repo,
   subdir = NULL,
@@ -85,8 +88,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    repo

    Repository address in the format username/repo[@ref].

    @@ -174,8 +177,8 @@

    Argumentsutils::install.packages().

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -189,26 +192,34 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_gitlab("jimhester/covr")
 }
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_local.html b/reference/install_local.html index cb5a5c62..ccce70e5 100644 --- a/reference/install_local.html +++ b/reference/install_local.html @@ -1,65 +1,70 @@ -Install a package from a local file — install_local • remotesInstall a package from a local file — install_local • remotes - Skip to content + -
    -
    -
    -

    Install a package from a local file

    - Source: R/install-local.R -
    install_local.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a package from a local file

    + Source: R/install-local.R +
    -
    +

    This function is vectorised so you can install multiple packages in a single command.

    -
    -

    Usage

    + 
    install_local(
   path = ".",
   subdir = NULL,
@@ -77,8 +82,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    path

    path to local directory, or compressed file (tar, zip, tar.gz tar.bz2, tgz2 or tbz)

    @@ -149,8 +154,8 @@

    Argumentsutils::install.packages().

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -164,8 +169,8 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 dir <- tempfile()
 dir.create(dir)
@@ -174,19 +179,27 @@ 
    Examples}
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_remote.html b/reference/install_remote.html index a3f33cd3..2837dea5 100644 --- a/reference/install_remote.html +++ b/reference/install_remote.html @@ -1,11 +1,5 @@ -Install a remote package. — install_remote • remotesInstall a remote package. — install_remote • remotes - Skip to content - - -
    -
    -
    -

    Install a remote package.

    - Source: R/install-remote.R -
    install_remote.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a remote package.

    + Source: R/install-remote.R +
    -
    +

    This:

    1. downloads source bundle

    2. decompresses & checks that it's a package

    3. adds metadata to DESCRIPTION

    4. calls install

    -
    -

    Usage

    + 
    install_remote(
   remote,
   dependencies,
@@ -98,8 +98,8 @@ 
    Usage
 remote_sha(remote, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    dependencies

    Which dependencies do you want to check? Can be a character vector (selecting from "Depends", "Imports", @@ -161,25 +161,33 @@

    Argumentsutils::install.packages().

    -
    -

    Details

    +
    +

    Details

    It uses the additional S3 generic functions to work. Writing methods for these functions would allow 3rd party packages to define custom remotes.

    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_svn.html b/reference/install_svn.html index 70578540..19e2ff01 100644 --- a/reference/install_svn.html +++ b/reference/install_svn.html @@ -1,65 +1,70 @@ -Install a package from a SVN repository — install_svn • remotesInstall a package from a SVN repository — install_svn • remotes - Skip to content + -
    -
    -
    -

    Install a package from a SVN repository

    - Source: R/install-svn.R -
    install_svn.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a package from a SVN repository

    + Source: R/install-svn.R +
    -
    +

    This function requires svn to be installed on your system in order to be used.

    -
    -

    Usage

    + 
    install_svn(
   url,
   subdir = NULL,
@@ -79,8 +84,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    url

    Location of package. The url should point to a public or private repository.

    @@ -161,13 +166,13 @@

    Argumentsutils::install.packages().

    -
    -

    Details

    +
    +

    Details

    It is vectorised so you can install multiple packages with a single command.

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -181,27 +186,35 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_svn("https://github.com/hadley/stringr/trunk")
 install_svn("https://github.com/hadley/httr/branches/oauth")
 }
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_url.html b/reference/install_url.html index 1978c118..df6b9d5a 100644 --- a/reference/install_url.html +++ b/reference/install_url.html @@ -1,65 +1,70 @@ -Install a package from a url — install_url • remotesInstall a package from a url — install_url • remotes - Skip to content + -
    -
    -
    -

    Install a package from a url

    - Source: R/install-url.R -
    install_url.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install a package from a url

    + Source: R/install-url.R +
    -
    +

    This function is vectorised so you can install multiple packages in a single command.

    -
    -

    Usage

    + 
    install_url(
   url,
   subdir = NULL,
@@ -77,8 +82,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    url

    location of package on internet. The url should point to a zip file, a tar file or a bzipped/gzipped tar file.

    @@ -149,8 +154,8 @@

    Argumentsutils::install.packages().

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -164,26 +169,34 @@

    See alsoinstall_version()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_url("https://github.com/hadley/stringr/archive/HEAD.zip")
 }
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/install_version.html b/reference/install_version.html index e7ab6aa6..88ecb81b 100644 --- a/reference/install_version.html +++ b/reference/install_version.html @@ -1,65 +1,70 @@ -Install specific version of a package. — install_version • remotesInstall specific version of a package. — install_version • remotes - Skip to content + -
    -
    -
    -

    Install specific version of a package.

    - Source: R/install-version.R -
    install_version.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Install specific version of a package.

    + Source: R/install-version.R +
    -
    +

    This function knows how to look in multiple CRAN-like package repositories, and in their archive directories, in order to find specific versions of the requested package.

    -
    -

    Usage

    + 
    install_version(
   package,
   version = NULL,
@@ -77,8 +82,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    package

    Name of the package to install.

    @@ -170,8 +175,8 @@

    Argumentsutils::install.packages().

    -
    -

    Details

    +
    +

    Details

    The repositories are searched in the order specified by the repos argument. This enables teams to maintain multiple in-house repositories with different policies - for instance, one repo for development snapshots and one for official releases. A common setup would be to first search @@ -180,8 +185,8 @@

    Detailsdevtools::has_devel (you need the devtools package for this).

    -
    -

    See also

    +
    +

    See also

    Other package installation: install_bioc(), install_bitbucket(), @@ -195,8 +200,8 @@

    See alsoinstall_url()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 install_version("devtools", "1.11.0")
 install_version("devtools", ">= 1.12.0, < 1.14")
@@ -212,19 +217,27 @@ 
    Examples}
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/package_deps.html b/reference/package_deps.html index 1dcbdef0..94dd4871 100644 --- a/reference/package_deps.html +++ b/reference/package_deps.html @@ -1,71 +1,74 @@ -Find all dependencies of a CRAN or dev package. — package_deps • remotesFind all dependencies of a CRAN or dev package. — package_deps • remotes - Skip to content - - -
    -
    -
    -

    Find all dependencies of a CRAN or dev package.

    - Source: R/deps.R -
    package_deps.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Find all dependencies of a CRAN or dev package.

    + Source: R/deps.R +
    -
    +

    Find all the dependencies of a package and determine whether they are ahead or behind CRAN. A print() method identifies mismatches (if any) between local and CRAN versions of each dependent package; an update() method installs outdated or missing packages from CRAN.

    -
    -

    Usage

    + 
    package_deps(
   packages,
   dependencies = NA,
@@ -99,8 +102,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    packages

    A character vector of package names.

    @@ -174,8 +177,8 @@

    Arguments -

    Value

    +
    +

    Value

    A data.frame with columns:

    @@ -185,8 +188,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 package_deps("devtools")
 # Use update to update any out-of-date dependencies
@@ -194,19 +197,27 @@ 
    Examples}
    -
    +

    + +
    -
    -
    + + + + + + + diff --git a/reference/parse-git-repo.html b/reference/parse-git-repo.html index 14739bf2..6cee3a5b 100644 --- a/reference/parse-git-repo.html +++ b/reference/parse-git-repo.html @@ -1,16 +1,5 @@ -Parse a remote git repo specification — parse-git-repo • remotesParse a remote git repo specification — parse-git-repo • remotes - Skip to content - - -
    -
    -
    -

    Parse a remote git repo specification

    - Source: R/parse-git.R -
    parse-git-repo.Rd
    + + +
    +
    +
    +

    Parse a remote git repo specification

    + Source: R/parse-git.R +
    -
    +

    A remote repo can be specified in two ways:

    as a URL

    parse_github_url() handles HTTPS and SSH remote URLs and various GitHub browser URLs

    @@ -85,8 +81,7 @@
    -
    -

    Usage

    + 
    parse_repo_spec(repo)
 
 parse_github_repo_spec(repo)
@@ -94,14 +89,14 @@ 
    Usage
 parse_github_url(repo)
    -
    -

    Arguments

    +
    +

    Arguments

    repo

    Character scalar, the repo specification.

    -
    -

    Value

    +
    +

    Value

    List with members: username, repo, subdir

    @@ -110,8 +105,8 @@

    Value

    ref, pull, release, some which will be empty.

    -
    -

    Examples

    +
    +

    Examples

    parse_repo_spec("metacran/crandb")
 #> $package
 #> [1] ""
@@ -408,19 +403,27 @@ 
    Examples#>
    -
    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/standardise_dep.html b/reference/standardise_dep.html index 33c1937e..982a066d 100644 --- a/reference/standardise_dep.html +++ b/reference/standardise_dep.html @@ -1,67 +1,73 @@ -Standardise dependencies using the same logical as install.packages — standardise_dep • remotesStandardise dependencies using the same logical as install.packages — standardise_dep • remotes - Skip to content + -
    -
    -
    -

    Standardise dependencies using the same logical as install.packages

    - Source: R/deps.R -
    standardise_dep.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Standardise dependencies using the same logical as install.packages

    + Source: R/deps.R +
    -
    +

    Standardise dependencies using the same logical as install.packages

    -
    -

    Usage

    + 
    standardise_dep(x)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    The dependencies to standardise. A character vector (selecting from "Depends", "Imports", @@ -74,25 +80,33 @@

    Arguments -

    See also

    +
    +

    See also

    https://r-pkgs.org/description.html for additional information on what each dependency type means.

    -

    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/system_requirements.html b/reference/system_requirements.html index 82e44cb1..b47b6da2 100644 --- a/reference/system_requirements.html +++ b/reference/system_requirements.html @@ -1,65 +1,70 @@ -Query the system requirements for a package (and its dependencies) — system_requirements • remotesQuery the system requirements for a package (and its dependencies) — system_requirements • remotes - Skip to content + -
    -
    -
    -

    Query the system requirements for a package (and its dependencies)

    - Source: R/system_requirements.R -
    system_requirements.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Query the system requirements for a package (and its dependencies)

    + Source: R/system_requirements.R +
    -
    +

    Returns a character vector of commands to run that will install system requirements for the queried operating system.

    -
    -

    Usage

    + 
    system_requirements(
   os,
   os_release = NULL,
@@ -69,8 +74,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    os, os_release

    The operating system and operating system release version, see https://github.com/rstudio/r-system-requirements#operating-systems for the @@ -92,26 +97,34 @@

    Arguments -

    Value

    +
    +

    Value

    A character vector of commands needed to install the system requirements for the package.

    -

    +
    + +
    -
    -
    + + + + + + + diff --git a/reference/update_packages.html b/reference/update_packages.html index 3d06ac5d..b9bd60c8 100644 --- a/reference/update_packages.html +++ b/reference/update_packages.html @@ -1,65 +1,70 @@ -Update packages that are missing or out-of-date. — update_packages • remotesUpdate packages that are missing or out-of-date. — update_packages • remotes - Skip to content + -
    -
    -
    -

    Update packages that are missing or out-of-date.

    - Source: R/deps.R -
    update_packages.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Update packages that are missing or out-of-date.

    + Source: R/deps.R +
    -
    +

    Works similarly to utils::install.packages() but doesn't install packages that are already installed, and also upgrades out dated dependencies.

    -
    -

    Usage

    + 
    update_packages(
   packages = TRUE,
   dependencies = NA,
@@ -76,8 +81,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    packages

    Character vector of packages to update.

    @@ -142,33 +147,41 @@

    Argumentsutils::install.packages().

    -
    -

    See also

    +
    +

    See also

    package_deps() to see which packages are out of date/ missing.

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 update_packages("ggplot2")
 update_packages(c("plyr", "ggplot2"))
 }
    -
    +
    + +
    -
    -
    + + + + + + +