README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# userlogo

The goal of userlogo is to customize the useR! logo with

* the chosen colour for the "use" and "!",

* the conference year.

## Installation


``` r
remotes::install_github("lockedata/userlogo")
```

## Example

Default logos.

```{r default}
magick::image_read_svg(system.file("extdata", "userlogo-withyear.svg",
                           package = "userlogo"))
magick::image_read_svg(system.file("extdata", "userlogo-withyear-square.svg",
                           package = "userlogo"))
```

Make them pink! This will create 2 PNG files and 2 SVG files in the folder you choose.

```{r pink}
dir <- tempdir()
userlogo::create_logo(colour = "#ffc0cb",
                      year = 2020,
                      folder = dir)

magick::image_read_svg(file.path(dir, "userlogo-withyear.svg"))
magick::image_read(file.path(dir, "userlogo-withyear.png"))
magick::image_read_svg(file.path(dir, "userlogo-withyear-square.svg"))
magick::image_read(file.path(dir, "userlogo-withyear-square.png"))
```