README.Rmd

---
output: github_document
---

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

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# ggpipe

*ggplot with the pipe*

This package wraps most `ggplot2` functions so they work with the pipe `%>%`
with [minimal overhead](http://rpubs.com/zeehio/ggpipe-overhead) (if noticeable).


[![Travis-CI Build Status](https://travis-ci.org/zeehio/ggpipe.svg?branch=master)](https://travis-ci.org/zeehio/ggpipe)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/ggpipe)](https://cran.r-project.org/package=ggpipe)


## Installation

You can install ggpipe from github with:

```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("zeehio/ggpipe")
```

## Example

```{r,message=FALSE, fig.height=3, fig.width=3}
# as ggpipe wraps ggplot2 functions, do not use library(ggplot2) in your scripts
library(ggpipe)
ggplot(mtcars) %>% 
  geom_point(aes(x = mpg, y = disp)) 
```

This package provides an additional `unggplot()` function to get back the data
from the plot, so multiple plots could be generated on a single pipe:

```{r}

iris_sepal_png <- "README-iris_sepal.png"
iris_petal_png <- "README-iris_petal.png"

iris %>%
  ggplot() %>%
  geom_point(aes(x = Sepal.Length, y = Sepal.Width, color = Species)) %>%
  ggsave(iris_sepal_png, height = 3, width = 5, dpi = 72) %>%
  unggplot() %>%
  ggplot() %>%
  geom_point(aes(x = Petal.Length, y = Petal.Width, color = Species)) %>%
  ggsave(iris_petal_png, height = 3, width = 5, dpi = 72) %>%
  unggplot() %>%
  head()
```

Plot the two figures:

```{r, fig.width=5, fig.height=3, dpi=72}
knitr::include_graphics(iris_sepal_png)
knitr::include_graphics(iris_petal_png)
```