rmNested-character-environment-method: Remove Nested (char-env)

In rappster/nestr: Nested object structures

Description

See generic: rmNested

Usage

## S4 method for signature 'character,environment'
rmNested(id, where = parent.frame(),
  strict = c(0, 1, 2), ...)

Arguments

id	character.
where	environment.
strict	logical. Controls what happens when id points to a non-existing component: 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/nestr

See Also

rmNested

Examples

## Not run: 

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

setNested(id = "a", value = TRUE)
exists("a", environment(), inherits = FALSE)
rmNested(id = "a")
exists("a", environment(), inherits = FALSE)

setNested(id = "a/b/c", value = 10, gap = TRUE)
exists("c", environment()$a$b, inherits = FALSE)
rmNested(id = "a/b/c")
exists("c", environment()$a$b, inherits = FALSE)

## Clean up //
rm(a)

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

where <- new.env()
setNested(id = "a/b/c", value = 10, where = where, gap = TRUE)
rmNested(id = "a/b/c", where = where)
exists("c", where$a$b, inherits = FALSE)

## Clean up //
rm(where)
  
##------------------------------------------------------------------------------
## Strictness //
##------------------------------------------------------------------------------

rmNested(id = "a")
try(rmNested(id = "a", strict = 1))
try(rmNested(id = "a", strict = 2))

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

rmNested(id = character()))
try(rmNested(id = character(), strict = 1))
try(rmNested(id = character(), strict = 2))
    

## End(Not run)

rappster/nestr documentation built on May 26, 2019, 11:22 p.m.