| Title: | Tools for Lists |
|---|---|
| Description: | Tools for common operations on lists. Provided are short-cuts to operations like selecting and merging data stored in lists. The functions in this package are designed to be used with pipes. |
| Authors: | Christian Hohenfeld [aut, cre, cph] |
| Maintainer: | Christian Hohenfeld <[email protected]> |
| License: | EUPL |
| Version: | 0.1.0 |
| Built: | 2024-10-22 06:22:17 UTC |
| Source: | CRAN |
Bind list elements together.
list_bind(in_list, ..., what = "rows", name = NULL)list_bind(in_list, ..., what = "rows", name = NULL)
in_list |
The list to work on. |
... |
A selection of elements to bind together. |
what |
Either 'rows' or 'cols'. |
name |
Optional name for the resulting element. |
The element to bind together must be compatible in the dimension you want to bind them together, if not there will either be an error or an unexpected result.
The 'what' parameter specifies whether to call 'rbind' or 'cbind' on the selected elements.
Using 'name' you can optionally specify a new name for the result. It will be in the position of the first selected element, while the other selected elements will be removed from the input list.
A list with the selected elements bound together as specified.
dfl <- list(data.frame(idx = 1:20, y = rnorm(20)), data.frame(idx = 21:40, y = rnorm(20)), data.frame(idx = 41:60, y = rnorm(20))) list_bind(dfl, 1, 2, 3)dfl <- list(data.frame(idx = 1:20, y = rnorm(20)), data.frame(idx = 21:40, y = rnorm(20)), data.frame(idx = 41:60, y = rnorm(20))) list_bind(dfl, 1, 2, 3)
Bind all elements together and extract them.
list_bind_all(in_list, what = "rows")list_bind_all(in_list, what = "rows")
in_list |
The list to work on. |
what |
Either 'rows' or 'cols' |
This a convenient wrapper around 'list_bind' which selects everything in the list and extracts the result.
All elements in the list bound together.
dfl <- list(data.frame(idx = 1:20, y = rnorm(20)), data.frame(idx = 21:40, y = rnorm(20)), data.frame(idx = 41:60, y = rnorm(20))) list_bind_all(dfl)dfl <- list(data.frame(idx = 1:20, y = rnorm(20)), data.frame(idx = 21:40, y = rnorm(20)), data.frame(idx = 41:60, y = rnorm(20))) list_bind_all(dfl)
This is pretty much an equivalent of calling '[[' on a list, but allows for cleaner use inside pipes.
list_extract(in_list, ...)list_extract(in_list, ...)
in_list |
The list to extract an element from. |
... |
A selection of what to extract. Must be a single element. |
The selected list element.
my_list <- list(rnorm(20), data.frame(x = 1:10, y = rnorm(10)), letters[1:5]) list_extract(my_list, 3)my_list <- list(rnorm(20), data.frame(x = 1:10, y = rnorm(10)), letters[1:5]) list_extract(my_list, 3)
Filter a list.
list_filter(in_list, filter_fun)list_filter(in_list, filter_fun)
in_list |
The list to filter. |
filter_fun |
The function to use for filtering. |
'filter_fun' must evaluate to TRUE or FALSE for filtering, where elements returning TRUE are kept.
A list, 'in_list' but filtered according to 'filter_fun.'
my_list <- list(aa = 1:3, bb = 1:4, cc = 2:5) list_filter(my_list, function(x) min(x) == 1) list_filter(my_list, function(x) max(x) > 3)my_list <- list(aa = 1:3, bb = 1:4, cc = 2:5) list_filter(my_list, function(x) min(x) == 1) list_filter(my_list, function(x) max(x) > 3)
'list_flatten()' works recursively through an input list and puts all elements of nested list to the top level. If there are no nested lists then the input is returned unchanged.
list_flatten(in_list, max_depth = -1)list_flatten(in_list, max_depth = -1)
in_list |
The list to flatten |
max_depth |
Maximum depth to recurse into. |
Using 'max_depth' you can control whether to flatten all nested lists. Negative values will cause all nested lists to be flattened, positive depths will limit the depth of the recursion.
A list without nested lists.
my_list <- list(a = list(1, 2, 3), b = list(4, 5, 6)) list_flatten(my_list)my_list <- list(a = list(1, 2, 3), b = list(4, 5, 6)) list_flatten(my_list)
Insert an element into a list.
list_insert(in_list, item, index, name = NULL, pad = FALSE) list_append(in_list, item, name = NULL) list_prepend(in_list, item, name = NULL)list_insert(in_list, item, index, name = NULL, pad = FALSE) list_append(in_list, item, name = NULL) list_prepend(in_list, item, name = NULL)
in_list |
The list to work on. |
item |
The item to add to the list. |
index |
The index to insert at. |
name |
Optional name for the new item. |
pad |
Add 'NULL' elements for too large indices? |
The 'index' behaves in the way that everything including the specified index will be moved one position forward. Thus, if you insert at index 2, the old item at index 2 will be moved to index 3. If 'index' is larger than the length of 'in_list' the default behaviour is to just add the new item to the end of the list, however if you specify 'pad = TRUE' then as many 'NULL' elements as needed are added to the list to insert 'item' at the specified location.
The functions 'list_append' and 'list_prepend' exist as a simple short-cut for appending and prepending to a list.
A list, the same as 'in_list' but with 'item' added at 'index'.
my_list <- list(foo1 = 1:10, foo2 = LETTERS[1:10]) list_insert(my_list, rnorm(3), 2, name = "bar")my_list <- list(foo1 = 1:10, foo2 = LETTERS[1:10]) list_insert(my_list, rnorm(3), 2, name = "bar")
This is a convenience function to check whether all elements of a list have the same class. It will only return TRUE if all elements in a list are of the exact same class. This means that if a list has two vectors TRUE will only be returned if they have the same mode or in case list has elements of compatible classes like data.frame and tbl.df the result will be false.
For the latter case there is 'list_is_compatible_class' that checks whether elements of vectors of classes overlap. Note that this does not necessarily mean that elements can be safely combined, this depends on the respective implementations.
list_is_same_class(list) list_is_compatible_class(list)list_is_same_class(list) list_is_compatible_class(list)
list |
The list to check. |
Boolean value.
test_list_false <- list(c(1, 2), c(3, 4), c("abc", "def")) list_is_same_class(test_list_false) test_list_true <- list(c(1, 2), c(3, 4)) list_is_same_class(test_list_true)test_list_false <- list(c(1, 2), c(3, 4), c("abc", "def")) list_is_same_class(test_list_false) test_list_true <- list(c(1, 2), c(3, 4)) list_is_same_class(test_list_true)
Join a list of data frames on a common index.
list_join_df(in_list, join_type = "inner", by = NULL, skip_non_df = FALSE)list_join_df(in_list, join_type = "inner", by = NULL, skip_non_df = FALSE)
in_list |
A list of data frames. |
join_type |
A string specifying the join strategy to use. Must be one of "inner", "left", "right" or "full". |
by |
Optional vector of strings specifying columns to merge by. |
skip_non_df |
Should elements that are not data.frames be skipped? |
Using 'join_type' you can specify how to join the data. The default 'inner' will keep only observations present in all data frames. 'left' will keep all observations from the first data frame in the list and merge the matching items from the rest, while 'right' will keep all observations from the last data frame in the list. Using 'full' will keep all observations.
If 'by' is not supplied, then data frames will be merged on columns with names they all have. Otherwise merging is done on the specified columns.
Using 'skip_non_df' you can specify to omit elements from the input list that are not data frames. If FALSE (the default) an error will be thrown if elements are present that are not data frames.
A data frame.
dfl <- list(data.frame(idx = sample(100, 30), x = rnorm(30)), data.frame(idx = sample(100, 30), y = rnorm(30)), data.frame(idx = sample(100, 30), z = rnorm(30))) list_join_df(dfl)dfl <- list(data.frame(idx = sample(100, 30), x = rnorm(30)), data.frame(idx = sample(100, 30), y = rnorm(30)), data.frame(idx = sample(100, 30), z = rnorm(30))) list_join_df(dfl)
Add the names of list items to data frames.
list_name_to_df(in_list, column_name = ".group", skip_non_df = TRUE)list_name_to_df(in_list, column_name = ".group", skip_non_df = TRUE)
in_list |
The list to work on. Must have names. |
column_name |
The name of the column to add to the data frames. |
skip_non_df |
Whether to skip items that are not data frames. |
With 'column_name' you can specify the name the new columns in the data.frames should have. The default is '.group'.
Using 'skip_non_df' you can specify to omit elements from the input list that are not data frames. If FALSE an error will be thrown if elements are present that are not data frames. If TRUE (the default) then items that are not data frames will be ignored and remain unchanged.
The input list with the name of the list item added in a new column for all data frames.
my_list <- list(group1 = data.frame(x = 1:10, y = rnorm(10)), group2 = data.frame(x = 1:10, y = rnorm(10))) list_name_to_df(my_list)my_list <- list(group1 = data.frame(x = 1:10, y = rnorm(10)), group2 = data.frame(x = 1:10, y = rnorm(10))) list_name_to_df(my_list)
Remove elements from a list.
list_remove(in_list, ...)list_remove(in_list, ...)
in_list |
The list to remove elements from. |
... |
Names or numeric positions of elements to remove. |
The list with the specified elements removed.
my_list <- list(a = rnorm(10), b = rnorm(10), c = rnorm(10)) list_remove(my_list, b)my_list <- list(a = rnorm(10), b = rnorm(10), c = rnorm(10)) list_remove(my_list, b)
Rename elements of a named list.
list_rename(in_list, ...)list_rename(in_list, ...)
in_list |
The list to rename elements in. |
... |
The renaming definitions. |
'list_rename()' changes the name of elements in a named list. The definitions for renaming are given in '...' in the style 'new_name = old_name'. You can specify as many renaming definitions as you like as long as there are not more definitions than elements in the list.
If no renaming definition is given the input list is returned. If you try to rename elements not present in the list nothing happens; unless you provide more renaming definitions than elements in the list, in that case an error is raised.
The list provided in 'in_list' with elements renamed according to the definition in '...'.
my_list <- list(a = 1, b = 2, c = 3) list_rename(my_list, AAA = "a", CCC = "c")my_list <- list(a = 1, b = 2, c = 3) list_rename(my_list, AAA = "a", CCC = "c")
Select parts of a list.
list_select(in_list, ...)list_select(in_list, ...)
in_list |
The list to select from. |
... |
The selection, can both be names and numeric positions. |
'list_select()' lets you select parts of a list either by position or by name. Names can be supplied as bare variable names and do not need to be supplied as strings or otherwise be quoted.
Elements are returned in the order they are given, this is useful if you want to reorder elements in a list. You can also rename while selecting, writing your selection like 'new_name = old_name'.
A list of the selected elements.
my_list <- list(a = c(1, 2), b = c(3, 4), c(5, 6)) list_select(my_list, a, 3)my_list <- list(a = c(1, 2), b = c(3, 4), c(5, 6)) list_select(my_list, a, 3)
Sort a list.
list_sort(in_list, sort_fun, descending = FALSE, use_na = "drop")list_sort(in_list, sort_fun, descending = FALSE, use_na = "drop")
in_list |
The list to work on. |
sort_fun |
The function to sort the list by. |
descending |
Boolean, if TRUE items will be sorted in descending order. |
use_na |
String, one of 'drop', 'first' or 'last'. |
The list will be sorted according to the return value of 'sort_fun'. The function must return a numeric value that will then be used to order the list items.
If the function returns 'NA' the sorting will depend on the string specified to 'use_missing'. The default is to drop these values, but they can optionally be put first or last in the sorted list.
If the sorting function returns 'NA' for some items and 'use_na' is 'first' or 'last' then the order of the 'NA' items will most likely be the same as in 'in_list' (but this cannot be guaranteed). The same is true for ties.
A list, 'in_list' sorted according to 'sort_fun'.
my_list <- list(data.frame(x = 1:10), data.frame(x = 1:5, y = rnorm(5)), data.frame(x = 1:20, y = rnorm(20), z = LETTERS[1:20])) list_sort(my_list, nrow) list_sort(my_list, function(x) sum(x$x), descending = TRUE)my_list <- list(data.frame(x = 1:10), data.frame(x = 1:5, y = rnorm(5)), data.frame(x = 1:20, y = rnorm(20), z = LETTERS[1:20])) list_sort(my_list, nrow) list_sort(my_list, function(x) sum(x$x), descending = TRUE)