create_option {zephyr} | R Documentation |
Create package option
Description
Use inside your package to setup a zephyr_option
that you can use in your
functions with get_option()
. The specification is stored inside the
environment of your package.
For more information and how to get started see use_zephyr()
.
Usage
create_option(name, default, description = name, .envir = parent.frame())
Arguments
name |
|
default |
|
description |
|
.envir |
Environment in which the option is defined. Default is suitable for use inside your package. |
Value
Invisible zephyr_option
object
Examples
create_option(
name = "answer",
default = 42,
description = "This is supposed to be the question"
)
[Package zephyr version 0.1.2 Index]