use_roxygen_md

If you are already using roxygen2, but not with markdown, you'll need to use
<a href="https://roxygen2md.r-lib.org">roxygen2md</a> to convert existing Rd expressions
to markdown. The conversion is not perfect, so make sure to check the
results.

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_roxygen_md function

<dl><dt>overwrite</dt>
<dd>Whether to overwrite an existing <code>Roxygen</code> field in
<code>DESCRIPTION</code> with <code>"list(markdown = TRUE)"</code>.</dd></dl>

Arguments

If you are already using roxygen2, but not with markdown, you'll need to use
<a href='https://roxygen2md.r-lib.org'>roxygen2md</a> to convert existing Rd expressions
to markdown. The conversion is not perfect, so make sure to check the
results.

Use roxygen2 with markdown — use_roxygen_md

<dl>

<dt>overwrite</dt>
<dd>Whether to overwrite an existing <code>Roxygen</code> field in
<code>DESCRIPTION</code> with <code>"list(markdown = TRUE)"</code>.</dd>

</dl>

use_roxygen_md: Use roxygen2 with markdown

Description

Usage

Arguments