as_roxygen_docs: Generate Standalone ?options Documentation
Description
Produce a comprehensive documentation page outlining all your defined
options' behaviors.
Usage
as_roxygen_docs(
title = paste(pkgname(env), "Options"),
desc = default_options_rd_desc(),
env = parent.frame()
)
Value
A character vector of roxygen2 tag segments
Arguments
- title
An optional, customized title (defaults to "Options")
- desc
An optional, customized description of behaviors
- env
An environemnt in which to find the associated options object
See Also
Other options_roxygen2:
as_params()
Examples
Run this code#' @eval options::as_roxygen_docs()
NULL
Run the code above in your browser using DataLab