rmRegistryValue: Remove Registry Value (generic)

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

Description

Removes registry value from the respective environment containing registry information (see initializeOptionContainer).

Usage

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

Arguments

id	Signature argument. Object containing path-like name/ID 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 id or where).
sub_id	character. Optional ID for a sub layer. Useful for a hub-like option container structure.
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.

Path-like identifiers

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.

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/optionr

See Also

rmRegistryValue-char-char-method, setRegistryValue, getRegistryValue, existsRegistryValue

Examples

## Not run: 

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

container <- initializeOptionContainer(overwrite = TRUE)
setRegistryValue(id = "a", value = TRUE)
rmRegistryValue(id = "a")
exists("a", container$.registry, inherits = FALSE)

setRegistryValue(id = "a/b/c", value = 10)
rmRegistryValue(id = "a/b/c")
exists("c", container$.registry$a$b, inherits = FALSE)

##------------------------------------------------------------------------------
## Different `where` //
##------------------------------------------------------------------------------
  
where <- "test"
container <- initializeOptionContainer(id = where, overwrite = TRUE)
".test" %in% names(options())
setRegistryValue(id = "a/b/c", value = 10, where = where)
rmRegistryValue(id = "a/b/c", where = where)
exists("c", container$.registry$a$b, inherits = FALSE)
  
where <- structure(list(id = "test"), class = "OptionContext.Test")
container <- initializeOptionContainer(id = where, overwrite = TRUE)
".test" %in% names(options())
setRegistryValue(id = "a/b/c", value = 10, where = where)
rmRegistryValue(id = "a/b/c", where = where)
exists("c", container$.registry$a$b, inherits = FALSE)

##------------------------------------------------------------------------------
## Strictness //
##------------------------------------------------------------------------------
  
container <- initializeOptionContainer(overwrite = TRUE)
rmRegistryValue(id = "a")
try(rmRegistryValue(id = "a", strict = 2))

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

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

## End(Not run)

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