use_github_links {usethis} | R Documentation |
Use GitHub links in URL and BugReports
Description
Populates the URL
and BugReports
fields of a GitHub-using R package with
appropriate links. The GitHub repo to link to is determined from the current
project's GitHub remotes:
If we are not working with a fork, this function expects
origin
to be a GitHub remote and the links target that repo.If we are working in a fork, this function expects to find two GitHub remotes:
origin
(the fork) andupstream
(the fork's parent) remote. In an interactive session, the user can confirm which repo to use for the links. In a noninteractive session, links are formed usingupstream
.
Usage
use_github_links(overwrite = FALSE)
Arguments
overwrite |
By default, |
Examples
## Not run:
use_github_links()
## End(Not run)
[Package usethis version 3.0.0 Index]