Skip to content

Commit a9b6872

Browse files
MikeJohnPageMikeJohnPage
committed
Remove downlit dependency and use standard rendering.
1 parent 5f7117d commit a9b6872

File tree

2 files changed

+46
-32
lines changed

2 files changed

+46
-32
lines changed

‎README.Rmd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
output: downlit::readme_document
2+
output: github_document
33
---
44

55
<!-- badges: start -->

‎README.md‎

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
<!-- badges: start -->
21

3-
[![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)
2+
<!-- badges: start -->
43

4+
[![Lifecycle:
5+
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
6+
[![rcc](https://github.com/tidyverse/blob/workflows/rcc/badge.svg)](https://github.com/tidyverse/blob/actions)
7+
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/blob)](https://cran.r-project.org/package=blob)
8+
[![Coverage
9+
Status](https://codecov.io/gh/tidyverse/blob/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tidyverse/blob)
510
<!-- badges: end -->
611

712
<!-- README.md is generated from README.Rmd. Please edit that file -->
@@ -10,44 +15,53 @@
1015

1116
## Overview
1217

13-
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.
18+
The goal of blob is to provide a simple S3 class to represent a vector
19+
of binary objects, aka blobs. The `blob` class is a lightweight wrapper
20+
around a list of raw vectors, suitable for inclusion in a data frame.
1421

15-
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.
22+
In most cases you will not need to use this package explicitly: it will
23+
be used transparently by packages that need to load BLOB columns from
24+
databases or binary file formats.
1625

1726
## Installation
1827

19-
<pre class='chroma'>
20-
<span><span class='c'># The easiest way to get blob is to install the whole tidyverse:</span></span>
21-
<span><span class='nf'><a href='https://rdrr.io/r/utils/install.packages.html'>install.packages</a></span><span class='o'>(</span><span class='s'>"tidyverse"</span><span class='o'>)</span></span>
22-
<span></span>
23-
<span><span class='c'># Alternatively, install just blob:</span></span>
24-
<span><span class='nf'><a href='https://rdrr.io/r/utils/install.packages.html'>install.packages</a></span><span class='o'>(</span><span class='s'>"blob"</span><span class='o'>)</span></span>
25-
<span></span>
26-
<span><span class='c'># Or the the development version from GitHub:</span></span>
27-
<span><span class='c'># install.packages("devtools")</span></span>
28-
<span><span class='nf'>devtools</span><span class='nf'>::</span><span class='nf'><a href='https://remotes.r-lib.org/reference/install_github.html'>install_github</a></span><span class='o'>(</span><span class='s'>"tidyverse/blob"</span><span class='o'>)</span></span></pre>
28+
``` r
29+
# The easiest way to get blob is to install the whole tidyverse:
30+
install.packages("tidyverse")
31+
32+
# Alternatively, install just blob:
33+
install.packages("blob")
34+
35+
# Or the the development version from GitHub:
36+
# install.packages("pak")
37+
pak::pak("tidyverse/blob")
38+
```
2939

3040
## Example
3141

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

34-
<pre class='chroma'>
35-
<span><span class='kr'><a href='https://rdrr.io/r/base/library.html'>library</a></span><span class='o'>(</span><span class='nv'><a href='https://blob.tidyverse.org'>blob</a></span><span class='o'>)</span></span>
36-
<span></span>
37-
<span><span class='nv'>x1</span> <span class='o'>&lt;-</span> <span class='nf'><a href='https://rdrr.io/r/base/rawConversion.html'>charToRaw</a></span><span class='o'>(</span><span class='s'>"Good morning"</span><span class='o'>)</span></span>
38-
<span><span class='nv'>x2</span> <span class='o'>&lt;-</span> <span class='nf'><a href='https://rdrr.io/r/base/raw.html'>as.raw</a></span><span class='o'>(</span><span class='nf'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='o'>(</span><span class='m'>0x48</span>, <span class='m'>0x65</span>, <span class='m'>0x6c</span>, <span class='m'>0x6c</span>, <span class='m'>0x6f</span><span class='o'>)</span><span class='o'>)</span></span>
39-
<span></span>
40-
<span><span class='nf'><a href='https://blob.tidyverse.org/reference/blob.html'>new_blob</a></span><span class='o'>(</span><span class='nf'><a href='https://rdrr.io/r/base/list.html'>list</a></span><span class='o'>(</span><span class='nv'>x1</span>, <span class='nv'>x2</span><span class='o'>)</span><span class='o'>)</span></span>
41-
<span><span class='c'>#&gt; &lt;blob[2]&gt;</span></span>
42-
<span><span class='c'>#&gt; [1] blob[12 B] blob[5 B]</span></span>
43-
<span><span class='nf'><a href='https://blob.tidyverse.org/reference/blob.html'>blob</a></span><span class='o'>(</span><span class='nv'>x1</span>, <span class='nv'>x2</span><span class='o'>)</span></span>
44-
<span><span class='c'>#&gt; &lt;blob[2]&gt;</span></span>
45-
<span><span class='c'>#&gt; [1] blob[12 B] blob[5 B]</span></span>
46-
<span></span>
47-
<span><span class='nf'><a href='https://blob.tidyverse.org/reference/blob.html'>as_blob</a></span><span class='o'>(</span><span class='nf'><a href='https://rdrr.io/r/base/c.html'>c</a></span><span class='o'>(</span><span class='s'>"Good morning"</span>, <span class='s'>"Good evening"</span><span class='o'>)</span><span class='o'>)</span></span>
48-
<span><span class='c'>#&gt; &lt;blob[2]&gt;</span></span>
49-
<span><span class='c'>#&gt; [1] blob[12 B] blob[12 B]</span></span></pre>
44+
``` r
45+
library(blob)
46+
47+
x1 <- charToRaw("Good morning")
48+
x2 <- as.raw(c(0x48, 0x65, 0x6c, 0x6c, 0x6f))
49+
50+
new_blob(list(x1, x2))
51+
#> <blob[2]>
52+
#> [1] blob[12 B] blob[5 B]
53+
blob(x1, x2)
54+
#> <blob[2]>
55+
#> [1] blob[12 B] blob[5 B]
56+
57+
as_blob(c("Good morning", "Good evening"))
58+
#> <blob[2]>
59+
#> [1] blob[12 B] blob[12 B]
60+
```
5061

5162
------------------------------------------------------------------------
5263

53-
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.
64+
Please note that the ‘blob’ project is released with a [Contributor Code
65+
of
66+
Conduct](https://github.com/tidyverse/blob/blob/main/CODE_OF_CONDUCT.md).
67+
By contributing to this project, you agree to abide by its terms.

0 commit comments

Comments
 (0)