existsAnywhereOption-character-environment-method: Check Existence of an Anywhere Option (char-env)

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

Description

See generic: existsAnywhereOption

Usage

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

Arguments

id	character.
where	environment.
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 existsAnywhereOption-char-env-method

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/optionr

See Also

existsAnywhereOption

Examples

## Not run: 

##------------------------------------------------------------------------------
## Basics //
##------------------------------------------------------------------------------

setAnywhereOption(id = "test", value = TRUE)
existsAnywhereOption(id = "test")

setAnywhereOption(id = "a/b/c", value = 10)
existsAnywhereOption(id = "a")
existsAnywhereOption(id = "a/b")
existsAnywhereOption(id = "a/b/c")
existsAnywhereOption(id = "a/b/c/d")

existsAnywhereOption(id = "c")
existsAnywhereOption(id = "c/d/e")
  
##------------------------------------------------------------------------------
## Strictness levels //
##------------------------------------------------------------------------------

## Empty ID //
existsAnywhereOption(id = character())
try(existsAnywhereOption(id = character(), strict = 1))
try(existsAnywhereOption(id = character(), strict = 2))

## Not-existing //  
existsAnywhereOption(id = "c/d/e")
try(existsAnywhereOption(id = "c/d/e", strict = 1))
try(existsAnywhereOption(id = "c/d/e", strict = 2))

##------------------------------------------------------------------------------
## Explicit `where` //
##------------------------------------------------------------------------------

where <- new.env()
setAnywhereOption(id = "a/b/c", value = 10, where = where)
existsAnywhereOption(id = "a/b/c", where = where)
existsAnywhereOption(id = "a/b/c/d", where = where)
existsAnywhereOption(id = "c/d/e", where = where)


## End(Not run)

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