insert_after: Insert after an item in a list

In MatthewHeun/IEATools: Tools for Working with International Energy Agency Data

Insert after an item in a list

Description

It is often helpful to insert an item into a list after another known item rather than at an index of the list as base::append() does. This function provides that functionality.

Usage

insert_after(
  x,
  after = NULL,
  values,
  .after_all = TRUE,
  .equals_function = `==`
)

Arguments

x	a list into which values is to be inserted
after	the object in x after which after will be inserted
values	the object to be inserted into x
.after_all	a boolean telling whether to insert values after after all instances of after (when TRUE, the default) or only the first instance of after (when FALSE).
.equals_function	insertion of values occurs at which(.equals_function(x, after)). Default is ==.

Details

If there are multiple copies of after in x, values is inserted after each after, unless .after_all = FALSE.

The positions at which insertions will occur are determined by the == operator. I.e., values are inserted in x after each position in x where x == after is true.

Note that length(after) must be 1.

If is.null(after), values is inserted once at the end of the list.

Value

a modified version of x

Examples

insert_after(list("a", "b", "c", "d", "c"), after = "c", values = "1")

MatthewHeun/IEATools documentation built on Dec. 14, 2024, 12:08 a.m.