linearizeNestedList: linearizeNestedList
In roneyfraga/caiporar: What the Package Does (One Line, Title Case)

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

View source: R/linearizeNestedList.R

Implements a recursive algorithm to linearize nested lists upto any arbitrary level of nesting.

linearizeNestedList(
  nList,
  linearizeDataFrames = FALSE,
  nameSep = "/",
  forceNames = FALSE
)

`nList`	The input `list`.
`linearizeDataFrames`	Logical. TRUE the columns in `data.frame`s will the "linearized". Default `FALSE`.
`nameSep`	Character to be the separation between names. Default "/".
`forceNames`	Logical. TRUE will rename list elements. Default `FALSE`.

Implements a recursive algorithm to linearize nested lists upto any arbitrary level of nesting (limited by R's allowance for recursion-depth). By linearization, it is meant to bring all list branches emanating from any nth-nested trunk upto the top-level trunk s.t. the return value is a simple non-nested list having all branches emanating from this top-level branch.

Since dataframes are essentially lists a boolean option is provided to switch on/off the linearization of dataframes. This has been found desirable in the author's experience. Also, one'd typically want to preserve names in the lists in a way as to clearly denote the association of any list element to it's nth-level history. As such we provide a clean and simple method of preserving names information of list elements. The names at any level of nesting are appended to the names of all preceding trunks using the nameSep option string as the seperator. The default / has been chosen to mimic the unix tradition of filesystem hierarchies. The default behavior works with existing names at any n-th level trunk, if found; otherwise, coerces simple numeric names corresponding to the position of a list element on the nth-trunk. Note, however, that this naming pattern does not ensure unique names for all elements in the resulting list. If the nested lists had non-unique names in a trunk the same would be reflected in the final list. Also, note that the function does not at all handle cases where some names are missing and some are not. Clearly, preserving the n-level hierarchy of branches in the element names may lead to names that are too long. Often, only the depth of a list element may only be important. To deal with this possibility a boolean option called forceNames has been provided. forceNames shall drop all original names in the lists and coerce simple numeric names which simply indicate the position of an element at the nth-level trunk as well as all preceding trunk numbers.

Akhil S Bhel

https://sites.google.com/site/akhilsbehl/geekspace/articles/r/linearize_nested_lists_in_r

unlist

## Not run: 
if(interactive()){
ml <- list(a = "a", 
          b = 1:3, 
          c = data.frame(x = runif(3), y = runif(3)), 
          d = list(a = list("a", "b"), 
                   b = list(list(1), list(2)))
 

linearizeNestedList(ml)
linearizeNestedList(ml, linearizeDataFrames = TRUE)
linearizeNestedList(ml, forceNames = TRUE)
linearizeNestedList(ml, forceNames = TRUE, nameSep = "_")
}

## End(Not run)