https://xvrdm.github.io/ggrough/

Convert ggplot2 chart to roughjs
https://xvrdm.github.io/ggrough/

Last synced: 2 months ago
JSON representation

Convert ggplot2 chart to roughjs

• Host: GitHub
• URL: https://xvrdm.github.io/ggrough/
• Owner: xvrdm
• Created: 2018-06-11T09:04:40.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-08T08:43:04.000Z (almost 3 years ago)
• Last Synced: 2024-08-03T23:24:34.505Z (6 months ago)
• Language: R
• Homepage: http://xvrdm.github.io/ggrough
• Size: 9.26 MB
• Stars: 90
• Watchers: 8
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

        
---

title: "ggRough"

output:

  github_document:

    html_preview: true

self_contained: TRUE

---

```{r echo=FALSE, message=FALSE, warning=FALSE}

knitr::opts_chunk$set(

  message = FALSE,

  collapse = TRUE,

  comment = "#>"

)

library(dplyr)

```



## What is `ggrough`?

`ggrough` is an R package that converts your [`ggplot2`](http://ggplot2.tidyverse.org) plots to rough/sketchy charts, using the excellent javascript [`roughjs`](http://roughjs.com) library.

```{r cars, fig.height=5, fig.width=12}

library(ggplot2)

count(mtcars, carb) %>%

  ggplot(aes(carb, n)) +

  geom_col() + 

  labs(title="Number of cars by carburator count") + 

  theme_grey(base_size = 16) -> p 

p

```

```{r eval=FALSE, eval=FALSE, echo=TRUE}

library(ggrough)

options <- list(

  Background=list(roughness=8),

  GeomCol=list(fill_style="zigzag", angle_noise=0.5, fill_weight=2))

get_rough_chart(p, options)

```

![](https://raw.githubusercontent.com/xvrdm/ggrough/master/man/figures/homepage_eg.png)

## How to install

```{r, eval=FALSE, echo=TRUE}

install.packages("devtools") # if you have not installed "devtools" package

devtools::install_github("xvrdm/ggrough")

```

## How to use

Call `get_rough_chart()`, using your ggplot2 chart as the first argument. [See this page for more ggrough examples and all the available options to customize your output](https://xvrdm.github.io/ggrough/articles/Customize%20chart.html).

## Word of caution

`ggrough` is a **work in progress** and **still has big bugs**. Contributions are welcome!

`ggrough` works "ok" with RStudio Viewer. However you need to redraw your chart everytime you change the size of the Viewer tab and the charts will redraw when you try to copy it via `Export -> Save As Image`. The latter can be annoying since some `roughjs` settings can add a lot of randomness. 

`ggrough` doesn't work well with Rmarkdown files yet. For example, it can only generate one chart per document. If you have multiple charts it overlays them on top of each other.

## Under the hood

`ggrough` is an [htmlwidget](http://htmlwidgets.org). It converts your [`ggplot2`](http://ggplot2.tidyverse.org) chart to SVG using the package [`svglite`](http://r-lib.github.io/svglite/) then parse the different elements (``, ``, ``...) to create a chart in a [HTML Canvas](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Tutorial) element^[`roughjs` can also render to SVG. This will be supported by `ggrough` in the future] with [`roughjs`](http://roughjs.com). 

An article explaining how `ggrough` works is in the making, to help potential contributors get started.

## Thanks

This package is only possible thanks to the massive work of:

- [Kent Russell — twitter:timelyportfolio](https://twitter.com/timelyportfolio) and [Bob Rudis — twitter:hrbrmstr](https://twitter.com/hrbrmstr) for the enormous educational content they created or shared about `htmlwidget` and `ggplot2`.

- [Preet Shihn — twitter:preetster](https://twitter.com/preetster) and all the contributors of [`roughjs`](http://roughjs.com).

- [Hadley Wickham — twitter:hadleywickham](https://twitter.com/hadleywickham) and all the contributors of [`ggplot2`](http://ggplot2.tidyverse.org).

- [Lionel Henry — twitter:_lionelhenry](https://twitter.com/_lionelhenry) and all the contributors of [`svglite`](http://r-lib.github.io/svglite/)