In rpahl/container: Extending Base 'R' Lists

require(container)
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#",
  prompt = F,
  fig.path = "images/README-",
  tidy = FALSE,
  cache = FALSE,
  out.width = "100%"
)

old <- options(width = 100L)

container

container provides an enhanced version of base R's list with a carefully designed set of extract, replace, and remove operations that make it easier and safer to work with list-like data structures.

Why container?

• safe and flexible operations to
• extract (built-in default values, no unintended NULL)
• add and replace (mixed indices, no unintended overrides)
• remove (loose or strict deletion, remove by index or value)
• compact printing
• optional reference semantics

In addition, this package provides specialized data structures Deque, Set and Dict and a special class dict.table, designed to extend data.table by container operations to safely Manage data columns with dict.table.

Installation

# Install release version from CRAN
install.packages("container")

# Install development version from GitHub
devtools::install_github("rpahl/container")

Usage

library(container)
co <- container(colors = c("Red", "Green"), numbers = c(1, 2, 3), data = cars)
co

Safe extract

at(co, "colours")   # oops

at(co, "colors")

Safe remove

co <- delete_at(co, "colours")   # oops

co <- delete_at(co, "colors")
co

Flexible peek

at(co, "colors")   # oops

peek_at(co, "colors")

peek_at(co, "colors", .default = c("black", "white"))

Safe replace

co <- replace_at(co, num = 1:10)   # oops

co <- replace_at(co, numbers = 1:10)
co

Getting Started

• Introduction to container
• Container operations for robust code
• Manage parameter lists with dict
• Manage data columns with dict.table

options(old)

rpahl/container documentation built on Nov. 10, 2023, 6:31 p.m.