index.qmd

<!-- badges: start -->
[![Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows.](https://www.repostatus.org/badges/latest/inactive.svg)](https://www.repostatus.org/#inactive)
[![License: GPLv3](https://img.shields.io/badge/license-GPLv3-bd0000.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/license-CC_BY--NC--SA_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
<!-- badges: end -->

## Overview

This report presents a reproducible workflow for generating QR codes in [R](https://www.r-project.org/).

You can also use the [`qr_code()`](https://danielvartan.github.io/rutils/reference/qr_code.html) function from the [`rutils`](https://danielvartan.github.io/rutils/) package to automate the process.

For more details about the implementation, see the [README](https://github.com/danielvartan/qr-code#qr-code) in the code repository.

> If you find this project useful, please consider giving it a star! [![GitHub repo stars](https://img.shields.io/github/stars/danielvartan/qr-code)](https://github.com/danielvartan/qr-code/)

## Set the Environment

### Load Packages

```{r}
#| label: Set the Environment
#| output: false

library(here)
library(magick)
library(qrcode)
library(rsvg)
```

```{r}
#| include: false

library(downlit)
library(xml2)
```

### Set Initial Variables

```{r}
link <- "https://github.com/danielvartan"
```

```{r}
logo <- here("images", "github-icon.svg")
```

```{r}
frame <- here("images", "qr-code-frame.svg")
```

## Generate the QR Code

```{r}
#| label: Generate the QR Code

qr_code <- link |> qr_code(ecl = "H")
```

```{r}
qr_code |>
  generate_svg(
    filename = here("images", "qr-code.svg"),
    size = 530,
    show = FALSE
  )
```

```{r}
#| include: false

file.copy(
  from = here("images", "qr-code.svg"),
  to = here("images", "favicon.svg"),
  overwrite = TRUE
)
```

![](images/qr-code.svg){fig-align="center" style="width: 50%"}

## Add a Logo

```{r}
#| label: Generate QR Code

qr_code |>
  add_logo(logo = logo, ecl = "L") |>
  generate_svg(
    filename = here("images", "qr-code-with-logo.svg"),
    size = 530,
    show = FALSE
  )
```

![](images/qr-code-with-logo.svg){fig-align="center" style="width: 50%"}

## Add a Frame

```{r}
#| label: Add Frame

qr_code <-
  here("images", "qr-code-with-logo.svg") |>
  image_read() |>
  image_trim() |>
  image_resize("450x450!")
```

```{r}
image_info(qr_code)
```

```{r}
#| eval: false
#| include: false

image_display(qr_code)
```

```{r}
frame <-
  frame |>
  image_read_svg(width = 550, height = 650)
```

```{r}
image_info(frame)
```

```{r}
#| eval: false
#| include: false

image_display(frame)
```

```{r}
composite <- image_composite(
  image = frame,
  composite_image = qr_code,
  offset = "+50 +50"
)
```

```{r}
image_info(composite)
```

```{r}
#| eval: false
#| include: false

image_display(composite)
```

```{r}
composite |>
  image_write(
    path = here("images", "qr-code-composite.png"),
    format = "png",
    quality = 100
  )
```

![](images/qr-code-composite.png){fig-align="center" style="width: 50%"}

## License

::: {style="text-align: left;"}
[![License: GPLv3](https://img.shields.io/badge/license-GPLv3-bd0000.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/license-CC_BY--NC--SA_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
:::

The code in this report is licensed under the [GNU General Public License Version 3](https://www.gnu.org/licenses/gpl-3.0), while the report is available under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/).

``` text
Copyright (C) 2025 Daniel Vartanian

The code in this report is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
```