rmAnywhereOption-character-character-method: Remove Free Option (char-char)

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

Description

See generic: rmAnywhereOption

Usage

## S4 method for signature 'character,character'
rmAnywhereOption(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	character.
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

logical. TRUE: removal successful; FALSE: removal failed.

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/optionr

See Also

rmAnywhereOption

Examples

## Not run: 

##------------------------------------------------------------------------------
## Default `where` //
##------------------------------------------------------------------------------

container <- initializeOptionContainer(overwrite = TRUE)
setAnywhereOption(id = "a", value = TRUE)
rmAnywhereOption(id = "a")
exists("a", container, inherits = FALSE)

setAnywhereOption(id = "a/b/c", value = 10)
rmAnywhereOption(id = "a/b/c")
exists("c", container$a$b, inherits = FALSE)

##------------------------------------------------------------------------------
## Different `where` // 
##------------------------------------------------------------------------------

where <- "test"
container <- initializeOptionContainer(id = where, overwrite = TRUE)
".test" %in% names(options())
## --> option container assigned to R option `.test`

setAnywhereOption(id = "a/b/c", value = 10, where = where)
rmAnywhereOption(id = "a/b/c", where = where)
exists("c", container$a$b, inherits = FALSE)

where <- structure(list(id = "test"), class = "OptionContext.Test")
container <- initializeOptionContainer(id = where, overwrite = TRUE)
setAnywhereOption(id = "a/b/c", value = 10, where = where)
rmAnywhereOption(id = "a/b/c", where = where)
exists("c", container$a$b, inherits = FALSE)
  
##------------------------------------------------------------------------------
## Strictness //
##------------------------------------------------------------------------------

container <- initializeOptionContainer(overwrite = TRUE)
rmAnywhereOption(id = "a")
try(rmAnywhereOption(id = "a", strict = 2))

rmAnywhereOption(id = "a/b/c")
try(rmAnywhereOption(id = "a/b/c", strict = 2))

rmAnywhereOption(id = character())
try(rmAnywhereOption(id = character(), strict = 2))
    

## End(Not run)

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