use_roxygen_md: Use roxygen2 with markdown
In r-lib/usethis: Automate Package and Project Setup
use_roxygen_md R Documentation
Use roxygen2 with markdown
Description
If you are already using roxygen2, but not with markdown, you'll need to use
roxygen2md to convert existing Rd expressions
to markdown. The conversion is not perfect, so make sure to check the
results.
Usage
use_roxygen_md(overwrite = FALSE)
Arguments
overwrite
Whether to overwrite an existing Roxygen field in
DESCRIPTION with "list(markdown = TRUE)".
r-lib/usethis documentation built on Nov. 28, 2024, 7:11 a.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.
| use_roxygen_md | R Documentation |
Use roxygen2 with markdown
Description
If you are already using roxygen2, but not with markdown, you'll need to use roxygen2md to convert existing Rd expressions to markdown. The conversion is not perfect, so make sure to check the results.
Usage
use_roxygen_md(overwrite = FALSE)
Arguments
overwrite |
Whether to overwrite an existing |
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.