use_github_links

0th

Percentile

Use GitHub links in URL and BugReports

Populates the URL and BugReports fields of a GitHub-using R package with appropriate links.

Usage
use_github_links(auth_token = NULL, host = "https://api.github.com",
  overwrite = FALSE)
Arguments
auth_token

Provide a personal access token (PAT) from https://github.com/settings/tokens. If NULL, will use the logic described in gh::gh_whoami() to look for a token stored in an environment variable. Use browse_github_pat() to help set up your PAT.

host

GitHub API host to use. Override with the endpoint-root for your GitHub enterprise instance, for example, "https://github.hostname.com/api/v3"

overwrite

By default, use_github_links() will not overwrite existing fields. Set to TRUE to overwrite existing links.

Aliases
  • use_github_links
Examples
# NOT RUN {
use_github_links()
# }
# NOT RUN {
# }
Documentation reproduced from package usethis, version 1.4.0, License: GPL-3

Community examples

Looks like there are no examples yet.