https://github.com/thierryo/qrcode

QRcode Generator for R
https://github.com/thierryo/qrcode

cran qrcode qrcode-generator r-package r-project

Last synced: 2 months ago
JSON representation

QRcode Generator for R

• Host: GitHub
• URL: https://github.com/thierryo/qrcode
• Owner: ThierryO
• License: gpl-3.0
• Created: 2021-06-27T13:18:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-17T13:27:05.000Z (10 months ago)
• Last Synced: 2024-05-01T12:39:58.158Z (8 months ago)
• Topics: cran, qrcode, qrcode-generator, r-package, r-project
• Language: R
• Homepage: https://Thierryo.github.io/qrcode
• Size: 400 KB
• Stars: 33
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
---

output: github_document

---

  [![CRAN status](https://www.r-pkg.org/badges/version/qrcode)](https://CRAN.R-project.org/package=qrcode)

  [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

  [![Lifecycle: stable](https://lifecycle.r-lib.org/articles/figures/lifecycle-stable.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable-1)

  ![GitHub](https://img.shields.io/github/license/thierryo/qrcode)

  [![Codecov](https://codecov.io/gh/ThierryO/qrcode/branch/main/graph/badge.svg?token=uOVomusTtw)](https://app.codecov.io/gh/ThierryO/qrcode)

  ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/thierryo/qrcode.svg)

  ![GitHub repo size](https://img.shields.io/github/repo-size/thierryo/qrcode.svg)

  [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5040089.svg)](https://doi.org/10.5281/zenodo.5040089)

# QRcode Generator for R 

A [QR code](https://en.wikipedia.org/wiki/QR_code) is a two-dimensional barcode developed by the Denso Wave company.

The current implementation handles three modes: numeric, alphanumeric and byte.

Kanji is currently not supported.

Please contact the maintainer if you need it.

- **Numeric**: only digits from 0 to 9

- **Alphanumeric**: all numeric characters, upper case `LETTERS`, and the characters `" "` (space), `"$"`, `"%"`, `"*"`, `"+"`, `"-"`, `"."`, `"/"` and `":"`

- **Byte**: All characters from the Latin 1 (ISO 8859-1) character set.

## Main functions

The main `qr_code()` function returns an object of the `qr_code` class.

This is a logical matrix with specific methods for printing and plotting.

The print version uses UTF-8 drawing symbols and the result depend on the font used.

For a better quality QR code it best to use `plot()` or `generate_svg()`.

```{r base}

library(qrcode)

code <- qr_code("QR CODE")

print(code)

```

```{r example, fig.path = "man/figures/", fig.alt = "A QR code displaying the value 'QR CODE'"}

plot(code)

```

```{r svg}

generate_svg(code, filename = "man/figures/qr.svg")

```

![A QR code displaying the value 'QR CODE'](man/figures/qr.svg)

## Installation

The `qrcode` package is available from CRAN, R universe and GitHub.

```{r eval = FALSE}

# install from CRAN

install.packages("qrcode")

# install from R universe

install.packages("qrcode", repos = "https://thierryo.r-universe.dev")

# install from GitHub use the remotes package

remotes::install_github("ThierryO/qrcode")

```

## Legacy code

The legacy function `qrcode_gen()` had several known bugs.

Because of these bugs, we re-implemented the code from scratch in version 0.1.4.

We created new functions.

The old functions are defunct since version 0.2.0.

We removed them in version 0.2.2.