build_rmd

build_readme

The Rmarkdown files to be rendered.

files

path to the package to build the readme.

path

List of output options that can override the options
specified in metadata (e.g. could be used to force <code>self_contained</code> or
<code>mathjax = "local"</code>). Note that this is only valid when the output
format is read from metadata (i.e. not a custom format object passed to
<code>output_format</code>).

output_options

additional arguments passed to <code><a rd-options="rmarkdown:render" href="/link/rmarkdown%3A%3Arender()?package=devtools&version=2.3.2&to=rmarkdown%3Arender" data-mini-rdoc="rmarkdown:render::rmarkdown::render()">rmarkdown::render()</a></code>

If <code>TRUE</code>, suppress output.

quiet

<code>build_rmd()</code> is a wrapper around <code><a rd-options="rmarkdown:render" href="/link/rmarkdown%3A%3Arender()?package=devtools&version=2.3.2&to=rmarkdown%3Arender" data-mini-rdoc="rmarkdown:render::rmarkdown::render()">rmarkdown::render()</a></code> that first installs
a temporary copy of the package, and then renders each <code>.Rmd</code> in a clean R
session. <code>build_readme()</code> locates your <code>README.Rmd</code> and builds it into a
<code>README.md</code>

Jim Hester

devtools

Tools to Make Developing R Packages Easier

Hadley Wickham

Winston Chang

RStudio 

R Core team 

build_rmd function

additional arguments passed to <code><a rd-options='rmarkdown:render' href='rmarkdown::render()'>rmarkdown::render()</a></code>

<code>build_rmd()</code> is a wrapper around <code><a rd-options='rmarkdown:render' href='rmarkdown::render()'>rmarkdown::render()</a></code> that first installs
a temporary copy of the package, and then renders each <code>.Rmd</code> in a clean R
session. <code>build_readme()</code> locates your <code>README.Rmd</code> and builds it into a
<code>README.md</code>

build_rmd: Build a Rmarkdown files package

Description

Usage

Arguments