getRegistryValue-character-character-method: Get Registry Value (char-char)

In rappster/optionr: Management of customized (and nested) project/package options

Description

See generic: getRegistryValue

Usage

## S4 method for signature 'character,character'
getRegistryValue(id,
  where = tryCatch(devtools::as.package(".")$package, error = function(cond) {
      stop("Invalid default value for `where`") }), sub_id = character(),
  default = NULL, strict = c(0, 1, 2), ...)

Arguments

id	character.
where	character.
sub_id	character. Optional ID for a sub layer. Useful for a hub-like option container structure.
default	ANY. Value to be returned if option does not exist. See getOption and getNested.
strict	logical. Controls what happens when id points to a non-existing registry object: 0: ignore and return FALSE to signal that the assignment process was not successful or fail_value depending on the value of return_status 1: ignore and with warning and return FALSE 2: ignore and with error
...	Further arguments to be passed to subsequent functions/methods.

Value

ANY. Component value or for invalid argument input and non-existing component the value of default unless strict == 1 in which case a warning is issued or strict == 2 in which case an error is thrown.

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/optionr

See Also

getRegistryValue

Examples

## 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)
setRegistryValue(id = "x_1", value = 10)
getRegistryValue(id = "x_1")

##------------------------------------------------------------------------------
## Explicit location of option container //
##------------------------------------------------------------------------------

initializeOptionContainer(id = "test", overwrite = TRUE)
setRegistryValue(id = "x_1", value = 10, where = "test")
getRegistryValue(id = "x_1", where = "test")

##------------------------------------------------------------------------------
## Sub ID //
##------------------------------------------------------------------------------

initializeOptionContainer(sub_id = "a", overwrite = TRUE)
setRegistryValue(id = "x_1", value = 10, sub_id = "a")
getRegistryValue(id = "x_1", sub_id = "a")


## End(Not run)

rappster/optionr documentation built on May 26, 2019, 11:23 p.m.