This function is very similar to usethis::use_citation() except that it uses a template from biocthis. This template can help you get started with a citation file for your Bioconductor package. You can compare the template produced with the one from usethis::use_citation() to pick and choose the parts you like best from each.

use_bioc_citation()

Value

This function adds and/or replaces the inst/CITATION file in your R package.

Examples


if (FALSE) {
## Run this function in your package
use_bioc_citation()
}

## Create an example package for illustrative purposes.
## Note: you do not need to run this for your own package!
pkgdir <- biocthis_example_pkg()
#> 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] (YOUR-ORCID-ID)
#> 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.1.2

## Create a template CITATION file that is Bioconductor-friendly
biocthis::use_bioc_citation()
#>  Creating 'inst/'
#>  Writing 'inst/CITATION'
#>  Edit 'inst/CITATION'