use_bcgov_github: Add your project to bcgov GitHub

In bcgov/bcgovr: Set Up of 'bcgov' R Projects & Packages

Add your project to bcgov GitHub

Description

This function requires that your project already be a Git repository. Use use_bcgov_git() to initialise a repository if necessary.

Usage

use_bcgov_github(
  organisation = "bcgov",
  rmarkdown = TRUE,
  licence = "apache2",
  coc_email = get_coc_email(),
  protocol = "https",
  ...
)

Arguments

organisation	GitHub organisation where the repo will be hosted. One of 'bcgov' (default), 'bcgov-c', or NULL to set up in your personal GitHub account
rmarkdown	Should an Rmarkdown file be added to the repository with its corresponding markdown file? Default FALSE.
licence	Which licence to apply? Default is Apache 2.0 ("apache2"). Use "cc-by" for Creative Commons Attribution 4.0
coc_email	Contact email address(es) for the Code of Conduct. It is recommended that you save this setting by adding a line like: options("bcgovr.coc.email" = "[e-mail]") to your .Rprofile. Use usethis::edit_r_profile() for an easy way to find and edit this file.
protocol	Transfer protocol. One of 'https' (default) or 'ssh'.
...	Other arguments passed on to usethis::use_github()

bcgov/bcgovr documentation built on Sept. 18, 2024, noon