build_rmd

build_readme

<code>build_rmd()</code> is a wrapper around <code><a href="https://pkgs.rstudio.com/rmarkdown/reference/render.html">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>

Jennifer Bryan

devtools

Tools to Make Developing R Packages Easier

Hadley Wickham

Jim Hester

Winston Chang

Posit Software, PBC 

build_rmd function

<dl><dt>files</dt>
<dd>The Rmarkdown files to be rendered.</dd>
<dt>path</dt>
<dd>path to the package to build the readme.</dd>
<dt>output_options</dt>
<dd>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>).</dd>
<dt>...</dt>
<dd>additional arguments passed to <code><a href="https://pkgs.rstudio.com/rmarkdown/reference/render.html">rmarkdown::render()</a></code></dd>
<dt>quiet</dt>
<dd>If <code>TRUE</code>, suppress output.</dd></dl>

Arguments

<code>build_rmd()</code> is a wrapper around <code><a href='https://pkgs.rstudio.com/rmarkdown/reference/render.html'>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 a Rmarkdown files package — build_rmd

<dl>

<dt>files</dt>
<dd>The Rmarkdown files to be rendered.</dd>


<dt>path</dt>
<dd>path to the package to build the readme.</dd>


<dt>output_options</dt>
<dd>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>).</dd>


<dt>...</dt>
<dd>additional arguments passed to <code><a href='https://pkgs.rstudio.com/rmarkdown/reference/render.html'>rmarkdown::render()</a></code></dd>


<dt>quiet</dt>
<dd>If <code>TRUE</code>, suppress output.</dd>

</dl>

build_rmd: Build a Rmarkdown files package

Description

Usage

Arguments