Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coolbutuseless/devoutpdf
A hand-crafted PDF graphics output device written in plain R
https://github.com/coolbutuseless/devoutpdf
Last synced: 28 days ago
JSON representation
A hand-crafted PDF graphics output device written in plain R
- Host: GitHub
- URL: https://github.com/coolbutuseless/devoutpdf
- Owner: coolbutuseless
- License: mit
- Created: 2019-10-07T10:24:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-08T11:41:55.000Z (about 5 years ago)
- Last Synced: 2024-08-03T21:03:04.498Z (3 months ago)
- Language: R
- Homepage: https://coolbutuseless.github.io/package/devoutpdf/
- Size: 434 KB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- awesome-r-dataviz - devoutpdf - A hand-crafted PDF graphics output device written in plain R. (ggplot / Devices)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
suppressPackageStartupMessages({
library(devout)
library(devoutpdf)
library(ggplot2)
})
```
```{r echo = FALSE, eval = FALSE}
# Quick logo generation. Borrowed heavily from Nick Tierney's Syn logo process
library(magick)
library(showtext)
font_add_google("Abril Fatface", "gf")
# pkgdown::build_site(override = list(destination = "../coolbutuseless.github.io/package/devoutpdf"))
```
```{r echo = FALSE, eval = FALSE}
img <- image_read("man/figures/white.png")
hexSticker::sticker(subplot = img,
s_x = 1,
s_y = 1.2,
s_width = 1.5,
s_height = 0.95,
package = "/dev/out/\npdf",
p_x = 1,
p_y = 1,
p_color = "#223344",
p_family = "gf",
p_size = 9,
h_size = 1.2,
h_fill = "#ffffff",
h_color = "#223344",
filename = "man/figures/logo.png")
image_read("man/figures/logo.png")
```
# devoutpdf 
`devoutpdf` is a hand-crafted PDF graphics device written in plain R.
It achieves this by invoking the [`devout`](https://github.com/coolbutuseless/devout)
package to do all the interfacing between the C++ side and the R side.
Drawing commands which sent to the graphics
device are used to construct a [`minipdf`](https://github.com/coolbutuseless/minipdf) document.
### Why would you want this?
Given that `pdf()` and `cairo_pdf()` devices come with R, what's the point of
a third PDF output device?
* Hacking your own graphics device gives a significant amount of control over the
actual output
* You can learn how a graphics device works - it's just R, so there's no C++ code to
sift through.
* Use as a template to write your own graphics device for something bespoke e.g.
pen plotter output or a laser projection driver!
* Glitch the output at the device level e.g. for each line, perhaps draw
multiple overlapping lines with randomly jittered endpoints to simulate a
'pencil sketch' effect.
### The R code
The R code for this device is a single file about 300 lines long - most of which
is whitespace and comments. Check it out [on github](https://github.com/coolbutuseless/devoutpdf-prep/blob/master/R/pdfout.R)
### ToDo
* Helvetica font is currently used regardless of what the user specifies. This
is a deficiency that first needs to be fixed in `minipdf`.
## Installation
You can install from [GitHub](https://github.com/coolbutuseless/devoutpdf) with:
``` r
# install.packages("devtools")
devtools::install_github("coolbutuseless/devout") # graphics device shim
devtools::install_github("coolbutuseless/minipdf") # PDF document builder
devtools::install_github("coolbutuseless/devoutpdf") # Devout PDF graphics device
```
## Example: ggplot scatterplot
```{r pdfout1, eval = TRUE}
devoutpdf::pdfout(filename = "man/figures/test1.pdf", width=5, height=4)
ggplot(mtcars) +
geom_point(aes(mpg, wt)) +
labs(title = "test1") +
theme_bw()
invisible(dev.off())
```
```{r include = FALSE}
system("convert -density 300 man/figures/test1.pdf -resize 100% -define png:exclude-chunks=date,time man/figures/test1.png")
```
```{r echo = FALSE, out.width="70%"}
knitr::include_graphics("man/figures/test1.png")
```
## Example: ggplot bar plot
```{r pdfout2, eval = TRUE, out.width = "75%"}
devoutpdf::pdfout(filename = "man/figures/test2.pdf", width = 6, height = 4)
ggplot(mtcars) +
geom_bar(aes(as.factor(cyl), fill = as.factor(cyl))) +
labs(title = "test2")
invisible(dev.off())
```
```{r include = FALSE}
system("convert -density 300 man/figures/test2.pdf -resize 100% -define png:exclude-chunks=date,time man/figures/test2.png")
```
```{r echo = FALSE}
knitr::include_graphics("man/figures/test2.png")
```
## Example: ggplot density plot
```{r pdfout3, eval = TRUE, out.width = "75%"}
devoutpdf::pdfout(filename = "man/figures/test3.pdf", width = 6, height = 4)
ggplot(mtcars) +
geom_density(aes(mpg, fill = as.factor(cyl)), alpha = 1, size = 2) +
theme_bw()
invisible(dev.off())
```
```{r include = FALSE}
system("convert -density 300 man/figures/test3.pdf -resize 100% -define png:exclude-chunks=date,time man/figures/test3.png")
```
```{r echo = FALSE}
knitr::include_graphics("man/figures/test3.png")
```
## Example: tmap world plot
```{r pdfout4}
library(tmap)
data("World")
devoutpdf::pdfout(filename = "man/figures/test4.pdf", width = 5, height = 4)
tm_shape(World) +
tm_polygons("HPI")
invisible(dev.off())
```
```{r include = FALSE}
system("convert -density 300 man/figures/test4.pdf -resize 100% -define png:exclude-chunks=date,time man/figures/test4.png")
```
```{r echo = FALSE}
knitr::include_graphics("man/figures/test4.png")
```
## Example: base graphics pie chart
```{r pdfout5}
devoutpdf::pdfout(filename = "man/figures/test5.pdf", width = 5, height = 4)
pie(c(cool = 4, but = 2, use = 1, less = 8))
invisible(dev.off())
```
```{r include = FALSE}
system("convert -density 300 man/figures/test5.pdf -resize 100% -define png:exclude-chunks=date,time man/figures/test5.png")
```
```{r echo = FALSE}
knitr::include_graphics("man/figures/test5.png")
```