Create a Bioconductor-styled code of conduct

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.

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

if (FALSE) { # \dontrun{
## Run this function in your package
use_bioc_coc()
} # }

## Create an example package for illustrative purposes.
## Note: you do not need to run this for your own package!
pkgdir <- biocthis_example_pkg()
#> ✔ Setting active project to "/tmp/RtmpKDAe9y/biocthisexample".
#> Package: biocthisexample
#> Title: What the Package Does (One Line, Title Case)
#> Version: 0.0.0.9000
#> Authors@R (parsed):
#>     * First Last <first.last@example.com> [aut, cre]
#> Description: What the package does (one paragraph).
#> License: `use_mit_license()`, `use_gpl3_license()` or friends to
#>     pick a license
#> Encoding: UTF-8
#> Roxygen: list(markdown = TRUE)
#> RoxygenNote: 7.3.2
#> ✔ Setting active project to "/tmp/RtmpKDAe9y/biocthisexample".

## Create a Bioconductor-styled CODE_OF_CONDUCT.md
biocthis::use_bioc_coc()
#> ✔ Creating .github/.
#> ✔ Adding "^\\.github$" to .Rbuildignore.
#> ✔ Adding "*.html" to .github/.gitignore.
#> ✔ Writing .github/CODE_OF_CONDUCT.md.
#> • Don't forget to describe the code of conduct in your README:
#>   ## Code of Conduct
#>   Please note that the biocthisexample project is released with a [Contributor Code of Conduct](http://bioconductor.org/about/code-of-conduct/). By contributing to this project, you agree to abide by its terms.