Description Usage Arguments Value Author(s) References See Also Examples
See generic: ensureOptionContainer
1 2 3 4 5 |
id |
|
container |
|
sub_id |
|
check |
|
hidden |
|
overwrite |
|
... |
Further arguments to be passed to subsequent functions/methods. |
logical
. TRUE
.
Janko Thyson janko.thyson@gmail.com
http://github.com/Rappster/optionr
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | ## Not run:
##------------------------------------------------------------------------------
## Default ID //
##------------------------------------------------------------------------------
options(".optionr" = NULL)
res <- ensureOptionContainer()
".optionr" %in% names(options())
ensureOptionContainer(overwrite = TRUE)
identical(getOption(".optionr"), res)
## --> identical environment object is reused --> ensures pass-by-references
## keeps working even when `overwrite = TRUE`
## Clean up //
options(".optionr" = NULL)
##------------------------------------------------------------------------------
## Explicit ID //
##------------------------------------------------------------------------------
res <- ensureOptionContainer(id = "abcd")
".abcd" %in% names(options())
ensureOptionContainer(id = "abcd", overwrite = TRUE)
identical(getOption(".abcd"), res)
## --> identical environment object is reused --> ensures pass-by-references
## keeps working even when `overwrite = TRUE`
## Clean up //
options(".abcd" = NULL)
##------------------------------------------------------------------------------
## Sub ID //
##------------------------------------------------------------------------------
res <- ensureOptionContainer(id = "abcd", sub_id = "a")
"a" %in% ls(res)
## Clean up //
options(".abcd" = NULL)
##------------------------------------------------------------------------------
## Not hidden //
##------------------------------------------------------------------------------
options("optionr" = NULL)
res <- ensureOptionContainer(hide = FALSE)
"optionr" %in% names(options())
identical(getOption("optionr"), res)
## Clean up //
options("optionr" = NULL)
##------------------------------------------------------------------------------
## Check for existing options of same name/ID //
##------------------------------------------------------------------------------
options(".optionr" = NULL)
res <- ensureOptionContainer()
try(ensureOptionContainer(check = TRUE))
## Clean up //
options(".optionr" = NULL)
##------------------------------------------------------------------------------
## As interface //
##------------------------------------------------------------------------------
id <- structure(list(id = "test"), class = "OptionContext.Test")
options("test" = NULL)
res <- ensureOptionContainer(id, hide = FALSE)
"test" %in% names(options())
identical(getOption(id$id), res)
## Clean up //
options("test" = NULL)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.