getByName: Get By Name (generic)

Description Usage Arguments Author(s) References See Also Examples

Description

Retrieves actual values based on their name.

Usage

1
2
getByName(input, value, outer = FALSE, resolve = FALSE, strict = c(0, 1,
  2), ...)

Arguments

input

Signature argument. Object containing structure information.

value

character. Name as found in return value of getStructure.

outer

logical. TRUE: use oindex instead of index to retrieve the outer element values (i.e., outer list structure is preserved); FALSE: use index to retrieve the inner element values (i.e. outer list structure is not preserved).

resolve

logical. TRUE: resolve path to basename component as names for return value; FALSE: use path as names for return value.

strict

numeric.

  • 0: ignore without warning

  • 1: ignore with Warning

  • 2: stop with error

...

Further arguments to be passed to subsequent functions/methods.

Author(s)

Janko Thyson [email protected]

References

http://github.com/rappster/listr

See Also

getByName-list-method, getStructure

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
## Not run: 

input <- list(
  x1 = list(x11 = list(x111 = list(x1111 = 1, x1112 = 2), x112 = 1), 
    x12 = list(x121 = 1, x122 = 1)),
  x2 = list(x21 = "x21"),
  x3 = list("x31"),
  x4 = "x4",
  x5 = list(1:3),
  list(list(1, 2), list(3, 4)),
  list(1:3),
  "char 1",
  "char 2",
  letters[1:3],
  c(1,3,5),
  TRUE,
  new.env(),
  data.frame(x = 1:3, y = 1:3)
)

## Inspect structure //
(struc <- getStructure(input))

getByName(input, value = "x1")

getByName(input, value = "x11")
getByName(input, value = "x21")

getByName(input, value = c("x11", "x21"))

## Condition handling //
getByName(input, value = "non-existing")
try(getByName(input, value = "non-existing", strict = 1))
try(getByName(input, value = "non-existing", strict = 2))


## End(Not run)

rappster/listr documentation built on May 24, 2017, 7:32 p.m.