list_options {zephyr} | R Documentation |
List package options
Description
List all zephyr_options
specified in a package. Either as an list
or as
as character
vector formatted for use in your package documentation.
To document your options use use_zephyr()
to set everything up, and edit
the created template as necessary.
Usage
list_options(
as = c("list", "params", "markdown"),
.envir = sys.function(which = -1)
)
Arguments
as |
|
.envir |
Environment in which the options are defined. Default is suitable for use inside your package. |
Value
list
or character
depending on as
Examples
# List all options in zephyr
x <- list_options(.envir = "zephyr")
print(x)
str(x)
# Create @params tag entries for each option
list_options(as = "params", .envir = "zephyr") |>
cat()
# List options in markdown format
list_options(as = "markdown", .envir = "zephyr") |>
cat()