Description Usage Arguments Value Author(s) References See Also Examples
See generic: setNested
1 2 3 4 5 |
id |
|
value |
|
where |
|
fail_value |
|
force |
|
gap |
|
must_exist |
|
reactive |
|
return_status |
|
strict |
|
typed |
|
See method
setNested-char-any-char-method
.
Janko Thyson janko.thyson@rappster.de
http://github.com/Rappster/nestr
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | ## Not run:
##------------------------------------------------------------------------------
## Basics //
##------------------------------------------------------------------------------
## Simple name/ID //
setNested(id = "test", value = TRUE)
getNested(id = "test")
## Path-like name/ID //
setNested(id = "test/a", value = TRUE, strict = 2)
## --> note that currently `test` is a leaf, not a branch
setNested(id = "test/a", value = TRUE, force = TRUE)
## --> `test` needs to be transformed from a "leaf"
## to a "branch" component (i.e. an environment); `force = TRUE`
## takes care of that
getNested(id = "test")
## --> branch
ls(getNested(id = "test"))
getNested(id = "test/a")
## --> leaf
## Must exist //
setNested(id = "test/b", value = TRUE, must_exist = TRUE)
try(setNested(id = "test/b", value = TRUE, must_exist = TRUE, strict = 2))
## Typed //
setNested(id = "test/c", value = "hello world!", typed = TRUE)
setNested(id = "test/c", value = 1:3)
## --> wrong class, but `strict_set = 0` --> disregarded without warning or error
getNested(id = "test/c")
## --> still `hello world!` because `value = 1:3` had wrong class
setNested(id = "test/c", value = "hello world!", typed = TRUE, strict_set = 1)
try(setNested(id = "test/c", value = 1:3))
## --> warning and no assignment
getNested(id = "test/c")
## --> still `hello world!`
setNested(id = "test/c", value = "hello world!", typed = TRUE, strict_set = 2)
try(setNested(id = "test/c", value = 1:3))
## --> error
getNested(id = "test/c")
## --> still `hello world!`
setNested(id = "test/a", value = "something else")
## --> correct class --> value changed
getNested(id = "test/a")
## Clean up //
rm(test)
##------------------------------------------------------------------------------
## Different `where` //
##------------------------------------------------------------------------------
where <- new.env()
setNested(id = "a/b/c", value = 10, where = where)
getNested(id = "a/b/c", where = where)
identical(getNested(id = "a/b/c", where = where), where$a$b$c)
## Clean up //
rm(where)
##------------------------------------------------------------------------------
## Return value //
##------------------------------------------------------------------------------
(setNested(id = "test", value = 10, return_status = FALSE))
## --> return value is `10` instead of `TRUE`
getNested(id = "test")
## Constellations that lead to failed assignment //
(setNested(id = "a/b", value = 10, gap = FALSE, return_status = FALSE))
## --> returns `NULL` as `fail_value = NULL`
getNested(id = "a/b")
## --> returns `NULL` as component does not exist and `default = NULL`
getNested(id = "a/b", default = "does not exist")
## --> returns `"does not exist"`
(setNested(id = "a/b", value = 10, gap = FALSE,
return_status = FALSE, fail_value = NA))
## --> returns `NA` as `fail_value = NA`
getNested(id = "a/b")
## --> returns `NULL` as component does not exist and `default = NULL`
##------------------------------------------------------------------------------
## Numerical names/IDs //
##------------------------------------------------------------------------------
setNested(id = "20140101", value = TRUE)
"20140101" %in% ls(all.names = TRUE)
getNested(id = "20140101")
## Clean up //
rm("20140101")
##------------------------------------------------------------------------------
## Branch gaps //
##------------------------------------------------------------------------------
setNested(id = "a/b/c/d", value = TRUE, gap = FALSE)
try(setNested(id = "a/b/c/d", value = TRUE, gap = FALSE, strict = 2))
## --> branch gap: branches a, b and c do not exist yet
## Closing the gap //
setNested(id = "a/b/c/d", value = TRUE)
## Inspect //
ls()
ls(getNested(id = "a"))
ls(getNested(id = "a/b"))
ls(getNested(id = "a/b/c"))
getNested(id = "a/b/c/d")
## Clean up //
rm(a)
##------------------------------------------------------------------------------
## Forcing leafs to branches //
##------------------------------------------------------------------------------
setNested(id = "a", value = "hello world!")
setNested(id = "a/b", value = 10)
try(setNested(id = "a/b", value = 10, strict = 2))
## --> currently, `a` is leaf instead of a branch (environment):
getNested(id = "a")
## Forcing leaf into a branch //
setNested(id = "a/b", value = 10, force = TRUE)
ls(getNested(id = "a"))
## --> branch
getNested(id = "a/b")
## --> leaf
## Clean up //
rm(a)
##------------------------------------------------------------------------------
## Forcing branches to leafs //
##------------------------------------------------------------------------------
setNested(id = "a/b", value = 10)
setNested(id = "a", value = 10)
try(setNested(id = "a", value = 10, strict = 2)
## --> currently, `a` is a branch that contains leafs --> structural
## inconsistency and therefore blocked until `force = TRUE`
## Forcing a branch into a leaf //
## That means all potentially existing leafs of that branch are lost!
setNested(id = "a", value = 10, force = TRUE)
getNested(id = "a")
## --> leaf
## Clean up //
rm(a)
##------------------------------------------------------------------------------
## Reactive object values //
##------------------------------------------------------------------------------
setNested(id = "dirs/root", value = getwd(), reactive = TRUE)
setNested(
id = "dirs/my_dir",
value = reactiveExpression(
file.path(getNested(id = "dirs/root", where = parent.frame(7)), "my_dir")
)
)
## --> `dirs/my_dir` should always dependent on of `dirs/root`
## --> note that you can ommit `reactive = TRUE` when `value = reactiveExpression(...)`
## --> Issue #1: need to specify `where = parent.frame(7)`
getNested(id = "dirs/root")
getNested(id = "dirs/my_dir")
## Changing via `setNested()` //
setNested(id = "dirs/root", value = tempdir())
getNested(id = "dirs/root")
getNested(id = "dirs/my_dir")
## When changed manually //
dirs$root <- "c:/temp"
dirs$root
dirs$my_dir
## Trying to change reactive observer //
setNested(id = "dirs/my_dir", value = TRUE)
getNested(id = "dirs/my_dir")
## --> has no effect; warning and error behavior can be
## controlled via `strict_set`
## Clean up //
rm(dirs)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.