getAnywhereOption-character-ANY-method: Get Anywhere Option (char-any)

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

Description

See generic: getAnywhereOption

Usage

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

Arguments

id	character.
where	ANY.
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 option 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

See method getAnywhereOption-char-env-method

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/optionr

See Also

getAnywhereOption

Examples

## Not run: 

## Also see examples at `?setAnywhereOption`
  
##------------------------------------------------------------------------------
## Basics //
##------------------------------------------------------------------------------

container <- initializeOptionContainer(overwrite = TRUE)
setAnywhereOption(id = "test", value = TRUE)
getAnywhereOption(id = "test")

setAnywhereOption(id = "a/b/c", value = 10)
getAnywhereOption(id = "a")
getAnywhereOption(id = "a/b")
getAnywhereOption(id = "a/b/c")
  
##------------------------------------------------------------------------------
## Different `where` //
##------------------------------------------------------------------------------

where <- "test"
container <- initializeOptionContainer(id = where, overwrite = TRUE)
setAnywhereOption(id = "a/b/c", value = 10, where = where)
getAnywhereOption(id = "a/b/c", where = where)

where <- structure(list(id = "test"), class = "OptionContext.Test")
container <- initializeOptionContainer(id = where, overwrite = TRUE)
setAnywhereOption(id = "a/b/c", value = 10, where = where)
getAnywhereOption(id = "a/b/c", where = where)
  

## End(Not run)

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