Description Usage Arguments Value Examples
Performs various substitutions in all .R
files in a package
to make use of the Markdown functionality in roxygen2
.
This function is designed for interactive use, see markdownify()
for details
on the transformations.
Also attempts to enable Markdown support in roxygen2
by adding a field to
DESCRIPTION
.
Carefully examine the results after running this function!
1 | roxygen2md(scope = c("full", "simple", "none"))
|
scope |
The scope of transformations: |
List of changed files, invisibly
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | if (interactive()) {
# Convert roxygen to Markdown in one run
roxygen2md()
}
# Alternatively, convert in three steps:
if (interactive()) {
# 1. Enable Markdown processing
roxygen2md("none")
menu("Please examine/commit the changes and press 1 <enter> to continue.")
# 2. Convert simple markup
roxygen2md("simple")
menu("Please examine/commit the changes and press 1 <enter> to continue.")
# 3. Convert everything, including links
roxygen2md("full")
}
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.