rmRegistryValue-character-ANY-method: Remove Registry Value (char-any)

Description Usage Arguments Value Author(s) References See Also Examples

Description

See generic: rmRegistryValue

Usage

1
2
3
4
5
## S4 method for signature 'character,ANY'
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

character.

where

ANY.

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.

Value

See method rmRegistryValue-char-any-method

Author(s)

Janko Thyson [email protected]

References

http://github.com/Rappster/optionr

See Also

rmRegistryValue

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
## 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 24, 2017, 7:33 p.m.