build_readme

0th

Percentile

Build a Rmarkdown README for a package

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()

Aliases
  • build_readme
Documentation reproduced from package devtools, version 2.2.0, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.