Skip to contents

Add a URL field to a package's DESCRIPTION

Source: R/49_use_url.R
use_url.Rd

Sets the URL field of a package's DESCRIPTION file. By default, the GitHub repository URL is detected from the configured git remote (origin). An additional pkgdown website URL can optionally be appended.

  • Requires that the target directory is an R package root (contains a DESCRIPTION file).

  • Both https:// and git@ style remotes are converted to a browser URL (a trailing .git suffix is removed).

Usage

use_url(url = NULL, pkgdown_url = NULL, path = NULL, ...)

Arguments

url

Character. The primary URL (usually the GitHub repository). If NULL (the default), it is detected from the git remote configuration.

pkgdown_url

Character. An optional pkgdown website URL, appended after url.

path

Path to the package root. If NULL (the default), the current working directory is used.

...

Must be empty. Reserved for future arguments.

Value

Invisibly returns the URLs that were written.

Examples

# \donttest{
tmpdir <- tempdir()
usethis::create_package(path = tmpdir)
#> ✔ Setting active project to "/tmp/RtmpEsKggO".
#> ℹ Leaving DESCRIPTION unchanged.
#> Package: RtmpEsKggO
#> Title: What the Package Does (One Line, Title Case)
#> Version: 0.0.0.9000
#> Authors@R (parsed):
#>     * First Last <first.last@example.com> [aut, cre]
#> Description: What the package does (one paragraph).
#> License: `use_mit_license()`, `use_gpl3_license()` or friends to
#>     pick a license
#> Config/roxygen2/version: 8.1.0
#> Encoding: UTF-8
#> Roxygen: list(markdown = TRUE)
#> ✔ Setting active project to "/tmp/RtmpEsKggO".
use_url(
  url = "https://github.com/WangLabCSU/rpkgkit",
  pkgdown_url = "https://wanglabcsu.github.io/rpkgkit/",
  path = tmpdir
)
#> ✔ Setting URL field to <https://github.com/WangLabCSU/rpkgkit> and
#>   <https://wanglabcsu.github.io/rpkgkit/>.
# }