use_bioc_description: Create a biocthis-style DESCRIPTION template

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

Create a biocthis-style DESCRIPTION template

Description

This function is very similar to usethis::use_description() except that it uses a template from biocthis. This template includes some of the information expected in the DESCRIPTION file of a Bioconductor package. You can compare the output of this function to the one from usethis::use_description() to select the parts you want from each.

Usage

use_bioc_description(biocViews = "Software", report_bioc = FALSE)

Arguments

biocViews

A character() with the Bioconductor biocViews terms you want to use for your package. See https://bioconductor.org/packages/release/BiocViews.html for details. Note that the terms you choose have to be part of one of the main four trees: software, annotation, experiment or workflow.

report_bioc

A logical(1) indicating whether to set the BugReports to the Bioconductor Support website https://support.bioconductor.org/ or to the GitHub package issues page. As noted on December 18 2024 at https://github.com/Bioconductor/Contributions/issues/3503#issuecomment-2551233199, Bioconductor reviewers prefer to use the GitHub issues page for BugReports. This is also documented at https://contributions.bioconductor.org/description.html#description-bugreport.

Details

For details about the DESCRIPTION file guidelines for Bioconductor packages check http://bioconductor.org/developers/package-guidelines/#description.

Value

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

Examples

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

## 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(use_git = TRUE)

## Create a template DESCRIPTION file that is Bioconductor-friendly
biocthis::use_bioc_description()

lcolladotor/biocthis documentation built on March 29, 2025, 4:22 a.m.