devtools (version 2.2.1)

build_readme: Build a Rmarkdown README for a package

Description

build_readme() is a wrapper around rmarkdown::render(), it generates the README.md from a README.Rmd file.

Usage

build_readme(path = ".", quiet = TRUE, ...)

Arguments

path

path to the package to build the readme.

quiet

If TRUE, suppress output.

...

additional arguments passed to rmarkdown::render()