container

Extends the functionality of base R list and provides specialized data structures deque, set, dict, and dict.table, the latter to extend the data.table package.

https://github.com/rpahl/container

Keywords

Repository

Extends the functionality of base R list and provides specialized data structures deque, set, dict, and dict.table, the latter to extend the data.table package.

README.Rmd

---
output: github_document
---



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

old <- options(width = 100L)
```



[![CRAN release](https://www.r-pkg.org/badges/version/container)](https://cran.r-project.org/package=container)
[![Dependencies](https://tinyverse.netlify.app/badge/container)](https://CRAN.R-project.org/package=container)
[![Code coverage](https://codecov.io/gh/rpahl/container/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rpahl/container)
[![R-CMD-check status](https://github.com/rpahl/container/workflows/R-CMD-check/badge.svg)](https://github.com/rpahl/container/actions)
[![Test coverage status](https://github.com/rpahl/container/workflows/test-coverage/badge.svg)](https://github.com/rpahl/container/actions)
[![CRAN checks](https://badges.cranchecks.info/summary/container.svg)](https://cran.r-project.org/web/checks/check_results_v01-interactive-usage.html)
[![Downloads per month](https://cranlogs.r-pkg.org/badges/last-month/container)](https://cran.r-project.org/package=container)
[![Downloads total](https://cranlogs.r-pkg.org/badges/grand-total/container)](https://cran.r-project.org/package=container)
[![Last commit](https://img.shields.io/github/last-commit/rpahl/container.svg)](https://github.com/rpahl/container/commits/master)
[![Lifecycle status](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)



# container 

The {container} package offers 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 use {container}?

{container} objects work similar to base R lists and on top provide

* safe and flexible operations to
  * extract (custom 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, {container} provides specialized data structures
[Deque, Set, and Dict]( articles/v05-deque-set-dict.html)
and a *special* class `dict.table`, designed to extend
[data.table](https://CRAN.R-project.org/package=data.table) by
container operations to safely
[Manage data columns with dict.table](articles/v04-manage-data-columns.html).


### Installation

```{r, eval = FALSE}
# Install release version from CRAN
install.packages("container")

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


### Usage

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

co
```

Use like a base R list

```{r}
co[["colors"]] <- c("Blue", "Yellow")

co[["colors"]]

co[2:1]
```

Safe extract

```{r, error = TRUE}
at(co, "colours")   # oops

at(co, "colors")
```

Safe remove

```{r, error = TRUE}
co <- delete_at(co, "colours")   # oops

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

Flexible peek

```{r, error = TRUE}
at(co, "colors")   # oops

peek_at(co, "colors")

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

Safe replace

```{r, error = TRUE}
co <- replace_at(co, num = 1:10)   # oops

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

### Get started

* [Use container in interactive session](articles/v01-interactive-usage.html)
* [Use container for code development](articles/v02-code-development.html)
* [Manage parameter lists with dict](articles/v03-parameter-list.html)
* [Manage data columns with dict.table](articles/v04-manage-data-columns.html)


### When *not* to use {container}

Don't bother using the {container} framework when *speed* is of high importance.
An exception is the `dict.table` class, which is very fast as it is based on
[data.table](https://CRAN.R-project.org/package=data.table).
Other than that, if computation speed is critical for your application,
we refer you to using base R lists or packages that were optimized for
performance, such as the
[collections](https://CRAN.R-project.org/package=collections) or
[cppcontainers](https://cran.r-project.org/package=cppcontainers) package.


```{r, include = FALSE}
options(old)
```

Owner

GitHub Events

Committers

Last synced: over 2 years ago

Issues and Pull Requests

Last synced: 6 months ago

Packages