vignetteAsREADME: Use the vignette as a README.md file

In Bioconductor/BiocAddins: Bioconductor Addins for RStudio

Use the vignette as a README.md file

Description

Create an R Markdown file that takes the vignette and knits it as the README.md file

Usage

vignetteAsREADME(pkgDir = ".", vignette, dir = "inst/scripts")

Arguments

pkgDir	The package directory to be build usually the current working directory (i.e., ".")
vignette	character(1) The filename of the vignette to be used as the README.md file
dir	character(1) The directory location within the package where to save the source vignette that will be converted to a README.md.

Examples

vignetteAsREADME()

Bioconductor/BiocAddins documentation built on July 5, 2025, 3:21 a.m.