Description Usage Arguments Path-like identifiers Author(s) References See Also Examples
Sets meta value inside the respective environment for meta information.
1 2 3 4 5 | setMetaValue(id, value, where = tryCatch(devtools::as.package(".")$package,
error = function(cond) { stop("Invalid default value for `where`") }),
sub_id = character(), fail_value = NULL, force = FALSE, gap = TRUE,
must_exist = FALSE, reactive = FALSE, return_status = TRUE,
strict = c(0, 1, 2), typed = FALSE, ...)
|
id |
Signature argument. Object containing path-like ID information. |
value |
Signature argument. Object containing value information. |
where |
Signature argument.
Object containing information about the location of the option container
that is to be used. Typically, this either corresponds to the name/ID
of a package/package project or an instance of a custom class for which
suitable methods in the context of managing options are defined
(see other methods of this package that have signature arguments
|
sub_id |
|
fail_value |
|
force |
|
gap |
|
must_exist |
|
reactive |
|
return_status |
|
strict |
|
typed |
|
Further |
arguments to be passed along to subsequent functions.
In particular:
|
Values for id
are expected to be of structure a/b/c/.../z
,
i.e. path-like identifiers using a slash as separator.
The identifier is transformed to a$b$c$...$z
and then in turn to a
valid get or assign
expression
(i.e. something similar to getOptionContainer(...)$a$b$c$...$z
and
getOptionContainer(...)$a$b$c$...$z <- value
).
Of course, "atomic" paths (e.g. only a
) are also valid.
Janko Thyson janko.thyson@gmail.com
http://github.com/Rappster/optionr
setMetaValue-char-any-char-method,
getMetaValue,
existsMetaValue,
rmMetaValue
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 | ## Not run:
##------------------------------------------------------------------------------
## Default location of option container //
##------------------------------------------------------------------------------
## NOTE
## Obmitting `where` (and `id` in `initializeOptionContainer()`) in the all
## calls will assign the overall option container to the package/project
## name (if `hidden = TRUE` it is additionally prepended by a `.`)
initializeOptionContainer(overwrite = TRUE)
setMetaValue(id = "x_1", value = 10)
getMetaValue(id = "x_1")
##------------------------------------------------------------------------------
## Explicit location of option container //
##------------------------------------------------------------------------------
initializeOptionContainer(id = "test", overwrite = TRUE)
setMetaValue(id = "x_1", value = 10, where = "test")
getMetaValue(id = "x_1", where = "test")
##------------------------------------------------------------------------------
## Sub ID //
##------------------------------------------------------------------------------
initializeOptionContainer(sub_id = "a", overwrite = TRUE)
setMetaValue(id = "x_1", value = 10, sub_id = "a")
getMetaValue(id = "x_1", sub_id = "a")
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.