use_details: Use details macros
In details: Create Details HTML Tag for Markdown and Package Documentation
use_details R Documentation
Use details macros
Description
Call this to import the details Rd macro into your package.
The RdMacros field of the DESCRIPTION file is updated so you can use the
\\foldstart{} and \\foldend{} macro in your documentation.
See the Package Documentation vignette of the details package.
Usage
use_details(desc_path = "./DESCRIPTION")
Arguments
desc_path
character, path to description file to check/edit, Default = './DESCRIPTION'
Details
This will append three elements to the DESCRIPTION file
Suggests: details
RdMacros: details
Roxygen: list(markdown = TRUE)
See Also
details
details documentation built on March 28, 2022, 1:06 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_details | R Documentation |
Use details macros
Description
Call this to import the details Rd macro into your package.
The RdMacros field of the DESCRIPTION file is updated so you can use the
\\foldstart{}and\\foldend{}macro in your documentation.
See the Package Documentation vignette of the details package.
Usage
use_details(desc_path = "./DESCRIPTION")
Arguments
desc_path |
character, path to description file to check/edit, Default = './DESCRIPTION' |
Details
This will append three elements to the DESCRIPTION file
Suggests: details
RdMacros: details
Roxygen: list(markdown = TRUE)
See Also
details
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.