dvmisc (version 1.1.4)

list_override: Add Elements of Second List to First List, Replacing Elements with Same Name

Description

Adds each element of list2 to list1, overriding any elements of the same name. Similar to modifyList function in utils package, but either list can be NULL. Useful for do.call statements, when you want to combine a list of default inputs with a list of user-specified inputs.

Usage

list_override(list1, list2)

Arguments

list1

Initial list that has some number of named elements. Can be NULL or an empty list.

list2

List with named elements that will be added to list1, replacing any elements with the same name. Can be NULL or an empty list.

Value

List containing the named elements initially in list1 and not in list2, any additional named elements in list2, and any named elements in list1 that were replaced by elements of the same name in list2.

Examples

# NOT RUN {
# Create list that has default inputs to the plot function
list.defaults <- list(x = 1: 5, y = 1: 5, type = "l", lty = 1)

# Create list of user-specified inputs to the plot function
list.user <- list(main = "A Straight Line", lty = 2, lwd = 1.25)

# Combine the two lists into one, giving priority to list.user
list.combined <- list_override(list.defaults, list.user)

# Plot data using do.call
do.call(plot, list.combined)

# }