use_bcgov_req: Add bcgov GitHub requirements to your project directory

View source: R/use.R

use_bcgov_reqR Documentation

Add bcgov GitHub requirements to your project directory

Description

Add a LICENCE file, a README, a CODE OF CONDUCT and a CONTRIBUTING file

Usage

use_bcgov_req(
  rmarkdown = FALSE,
  coc_email = get_coc_email(),
  licence = "apache2"
)

Arguments

rmarkdown

Should an Rmarkdown file be added to the repository with its corresponding markdown file? Default FALSE.

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" = "your.email@gov.bc.ca") to your .Rprofile. Use usethis::edit_r_profile() for an easy way to find and edit this file.

licence

Which licence to apply? Default is Apache 2.0 ("apache2"). Use "cc-by" for Creative Commons Attribution 4.0


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