Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vgherard/r2r
R-Object to R-Object Hash Maps
https://github.com/vgherard/r2r
data-structures hashtable r
Last synced: about 1 month ago
JSON representation
R-Object to R-Object Hash Maps
- Host: GitHub
- URL: https://github.com/vgherard/r2r
- Owner: vgherard
- License: gpl-3.0
- Created: 2021-04-30T07:54:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-09T10:26:37.000Z (2 months ago)
- Last Synced: 2024-12-12T02:46:48.369Z (about 1 month ago)
- Topics: data-structures, hashtable, r
- Language: R
- Homepage: https://vgherard.github.io/r2r/
- Size: 362 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# r2r
[](https://CRAN.R-project.org/package=r2r)
[](https://github.com/vgherard/r2r/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/vgherard/r2r)
[](https://vgherard.r-universe.dev/)
[](https://vgherard.github.io/r2r/)
[](https://twitter.com/intent/tweet?text={r2r}:%20R-Object%20to%20R-Object%20Hash%20Maps&url=https://vgherard.github.io/r2r&via=ValerioGherardi&hashtags=rstats,datastructures,hashtables)
[`r2r`](https://vgherard.github.io/r2r/) provides a flexible implementation of hash tables in R, allowing for:
- arbitrary R objects as keys and values,
- arbitrary key comparison and hash functions,
- customizable behaviour (throw or return a default value) on missing key exceptions.
## Installation
You can install the released version of `r2r` from [CRAN](https://CRAN.R-project.org/package=r2r) with:
``` r
install.packages("r2r")
```
and the development version from [my R-universe repository](https://vgherard.r-universe.dev/), with:
``` r
install.packages("r2r", repos = "https://vgherard.r-universe.dev")
```
## Usage
```{r}
library(r2r)
m <- hashmap()
# Insert and query a single key-value pair
m[[ "user" ]] <- "vgherard"
m[[ "user" ]]
# Insert and query multiple key-value pairs
m[ c(1, 2, 3) ] <- c("one", "two", "three")
m[ c(1, 3) ]
# Keys and values can be arbitrary R objects
m[[ lm(mpg ~ wt, mtcars) ]] <- c(TRUE, FALSE, TRUE)
m[[ lm(mpg ~ wt, mtcars) ]]
```
## Getting help
For further details, including an introductory vignette illustrating the features of `r2r` hash maps, you can consult the `r2r` [website](https://vgherard.github.io/r2r/). If you encounter a bug, want to suggest a feature or need further help, you can [open a GitHub issue](https://github.com/vgherard/r2r/issues).
## Comparison with `hash`
CRAN package [`{hash}`](https://CRAN.R-project.org/package=hash) also offers an implementation of hash tables based on R environments. The two tables below offer a comparison between `{r2r}` and `{hash}` (for more details, see the [benchmarks](https://vgherard.github.io/r2r/articles/benchmarks.html) Vignette)
```{r echo=FALSE}
knitr::kable(
data.frame(
Feature = c(
"Basic data structure",
"Arbitrary type keys",
"Arbitrary type values",
"Arbitrary hash function",
"Arbitrary key comparison function",
"Throw or return default on missing keys",
"Hash table inversion"
),
r2r = c("R environment", "X", "X", "X", "X", "X", ""),
hash = c("R environment", "", "X", "", "", "", "X")
),
align = "c",
caption = "Features supported by {r2r} and {hash}."
)
```
```{r echo=FALSE}
knitr::kable(
data.frame(
Task = c(
"Key insertion",
"Key query",
"Key deletion"
),
Comparison = c(
"{r2r} ~ {hash}",
"{r2r} < {hash}",
"{r2r} << {hash}"
)
),
align = "c",
caption = "Performances of {r2r} and {hash} for basic hash table operations."
)
```