https://github.com/tidyverse/blob

A simple S3 class for representing BLOBs
https://github.com/tidyverse/blob

database r

Last synced: 11 days ago
JSON representation

A simple S3 class for representing BLOBs

• Host: GitHub
• URL: https://github.com/tidyverse/blob
• Owner: tidyverse
• License: other
• Created: 2016-10-27T13:11:54.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T05:35:42.000Z (11 days ago)
• Last Synced: 2024-10-27T05:40:58.947Z (11 days ago)
• Topics: database, r
• Language: R
• Homepage: https://blob.tidyverse.org
• Size: 2.43 MB
• Stars: 45
• Watchers: 7
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
---

output: downlit::readme_document

---

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

[![rcc](https://github.com/tidyverse/blob/workflows/rcc/badge.svg)](https://github.com/tidyverse/blob/actions)

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/blob)](https://cran.r-project.org/package=blob)

[![Coverage Status](https://codecov.io/gh/tidyverse/blob/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidyverse/blob)

```{r, include = FALSE}

pkgload::load_all()

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "README-"

)

```

# blob

## Overview

The goal of blob is to provide a simple S3 class to represent a vector of binary objects, aka blobs. The `blob` class is a lightweight wrapper around a list of raw vectors, suitable for inclusion in a data frame.

In most cases you will not need to use this package explicitly: it will be used transparently by packages that need to load BLOB columns from databases or binary file formats.

## Installation

```r

# The easiest way to get blob is to install the whole tidyverse:

install.packages("tidyverse")

# Alternatively, install just blob:

install.packages("blob")

# Or the the development version from GitHub:

# install.packages("devtools")

devtools::install_github("tidyverse/blob")

```

## Example

To create a blob, use `blob()`, `new_blob()` or `as_blob()`:

```{r example}

library(blob)

x1 <- charToRaw("Good morning")

x2 <- as.raw(c(0x48, 0x65, 0x6c, 0x6c, 0x6f))

new_blob(list(x1, x2))

blob(x1, x2)

as_blob(c("Good morning", "Good evening"))

```

---

Please note that the 'blob' project is released with a

[Contributor Code of Conduct](https://github.com/tidyverse/blob/blob/main/CODE_OF_CONDUCT.md).

By contributing to this project, you agree to abide by its terms.