use_vignette

use_article

Creates a new vignette or article in <code>vignettes/</code>. Articles are a special
type of vignette that appear on pkgdown websites, but are not included
in the package itself (because they are added to <code>.Rbuildignore</code>
automatically).

Automate package and project setup tasks that are otherwise
performed manually. This includes setting up unit testing, test
coverage, continuous integration, Git, 'GitHub', licenses, 'Rcpp',
'RStudio' projects, and more.

Jennifer Bryan

usethis

Automate Package and Project Setup

Hadley Wickham

Malcolm Barrett

Andy Teucher

Posit Software, PBC 

use_vignette function

<dl><dt>name</dt>
<dd>Base for file name to use for new vignette. Should consist only
of numbers, letters, <code>_</code> and <code>-</code>. Lower case is recommended.</dd>
<dt>title</dt>
<dd>The title of the vignette.</dd></dl>

Arguments

<ul>
<li>Adds needed packages to <code>DESCRIPTION</code>.</li>
<li>Adds <code>inst/doc</code> to <code>.gitignore</code> so built vignettes aren't tracked.</li>
<li>Adds <code>vignettes/*.html</code> and <code>vignettes/*.R</code> to <code>.gitignore</code> so
you never accidentally track rendered vignettes.</li>
</ul>

General setup

Create a vignette or article — use_vignette

<dl>

<dt>name</dt>
<dd>Base for file name to use for new vignette. Should consist only
of numbers, letters, <code>_</code> and <code>-</code>. Lower case is recommended.</dd>


<dt>title</dt>
<dd>The title of the vignette.</dd>

</dl>

<ul>
<li>Adds needed packages to <code>DESCRIPTION</code>.</li>
<li>Adds <code>inst/doc</code> to <code>.gitignore</code> so built vignettes aren't tracked.</li>
<li>Adds <code>vignettes/*.html</code> and <code>vignettes/*.R</code> to <code>.gitignore</code> so
you never accidentally track rendered vignettes.</li>
</ul>

use_vignette: Create a vignette or article

Description

Usage

Arguments

General setup

See Also

Examples