packager (version 1.8.0)

set_desc_url: Set a DESCRIPTION File's URL Field

Description

I frequently forget to add an URL to my packages' DESCRIPTION files, and when I do not, I often forget to check that the URL is valid, respectively the one I want. So this is a wrapper to functions from desc and git2r and i messaging and/or adding a reminder to file TODO.md.

Usage

set_desc_url(
  url,
  path = ".",
  normalize = TRUE,
  overwrite = FALSE,
  do_commit = is_force(),
  do_remind = !isTRUE(getOption("packager")[["force"]]),
  verbose = getOption("packager")[["verbose"]]
)

Arguments

url

A character string giving the URL to set or add in DESCRIPTION.

path

Path to the DESCRIPTION file, see desc::desc_get_urls.

normalize

See desc::desc_set_urls.

overwrite

Set (overwrite) the URL field in DESCRIPTION instead adding the URL given to the URL field in DESCRIPTION?

do_commit

Commit the updated DESCRIPTION?

do_remind

Write a reminder into the package's TODO.md?

verbose

Be verbose?

Value

Invisibly TRUE

Examples

# NOT RUN {
path <- file.path(tempdir(), "myPackage")
unlink(path, recursive = TRUE)
usethis::create_package(path, open = FALSE)
repo <- git2r::init(path)
git2r::config(repo, user.name = "foobar", user.email = "[e-mail]")
git2r::add(repo = repo, path = "*")
git2r::commit(repo = repo, message = "Initial commit")
url <- provide_gitlab_url(path = path)
set_desc_url(url, path = path)
git2r::commits(repo)
git2r::status(repo)
readLines(file.path(path, "TODO.md"))
# }