reBuildREADMEmd: Rebuild the README.md from the README.Rmd file

In Bioconductor/BiocAddins: Bioconductor Addins for RStudio

Rebuild the README.md from the README.Rmd file

Description

This function rebuilds the README.md file by running the command in the README.Rmd file.

Usage

reBuildREADMEmd(pkgDir = ".", readme, dir = "inst/scripts")

Arguments

pkgDir	The package directory to be build usually the current working directory (i.e., ".")
readme	character(1) The path to the README.Rmd to be rendered into 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

reBuildREADMEmd()

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