build_readme: Build README
In devtools: Tools to Make Developing R Packages Easier
build_readme R Documentation
Build README
Description
Renders an executable README, i.e. README.qmd or README.Rmd, to
README.md. Specifically, build_readme():
Installs a copy of the package's current source to a temporary library
Renders the README in a clean R session
Usage
build_readme(path = ".", quiet = TRUE, ...)
Arguments
path
Path to the top-level directory of the source package.
quiet
If TRUE, suppresses most output. Set to FALSE
if you need to debug.
...
Additional arguments passed to rmarkdown::render(), in the
case of README.Rmd. Not used for README.qmd
devtools documentation built on March 14, 2026, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| build_readme | R Documentation |
Build README
Description
Renders an executable README, i.e. README.qmd or README.Rmd, to
README.md. Specifically, build_readme():
Installs a copy of the package's current source to a temporary library
Renders the README in a clean R session
Usage
build_readme(path = ".", quiet = TRUE, ...)
Arguments
path |
Path to the top-level directory of the source package. |
quiet |
If |
... |
Additional arguments passed to |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.