use_bioc_coc: Create a Bioconductor-styled code of conduct

In lcolladotor/biocthis: Automate package and project setup for Bioconductor packages

Create a Bioconductor-styled code of conduct

Description

This function is very similar to usethis::use_tidy_cov() except that it uses a template from biocthis. This template links to the Bioconductor Code of Conduct available at http://bioconductor.org/about/code-of-conduct/. The function adds by default the file .github/CODE_OF_CONDUCT.md with a brief overview of the Bioconductor Code of Conduct and links to the latest version.

Usage

use_bioc_coc(path = ".github")

Arguments

path	A character(1) specifying the location where the CODE_OF_CONDUCT.md will be saved at in relation to the root of your R package.

Value

This function adds and/or replaces the .github/CODE_OF_CONDUCT.md file in your R package.

Examples

## Not run: 
## Run this function in your package
use_bioc_coc()

## End(Not run)

## Create an example package for illustrative purposes.
## Note: you do not need to run this for your own package!
pkgdir <- biocthis_example_pkg()

## Create a Bioconductor-styled CODE_OF_CONDUCT.md
biocthis::use_bioc_coc()

lcolladotor/biocthis documentation built on Dec. 12, 2024, 10:01 p.m.