In coolbutuseless/optout: Optimized Output for Graphics Devices
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
library(dplyr)
library(ggplot2)
library(optout)
library(withr)
optout - Optimized Graphics Output
This package enables access to some common command-line image optimization and
compression tools from within R, with a mostly consistent call interface.
Tools are included for interfacing command line tools for compressing
JPG, PNG and PDF files.
My Use Case
The vignettes for ggpattern
are huge because of all the image-based examples. I want to be able to optimize and
compress the vignette images from within the Rmd files to try and keep
the packge under a reasonable size.
Security Warning
This package does a lot of system2() calls with user input. I've
sanitised all user input, but nothing is ever perfect, so in general
this library should not accept input from the internet e.g. as part of a shiny
app.
Installation
You can install the development version from GitHub with:
# install.packages("remotes")
remotes::install_github("coolbutuseless/optout")
This package relies on your system having installed the following command line
programs. If a particular utility is not installed, the package will still
load fine, but you will not be able to use that particular compression type.
- PNG compression
- JPEG compression
- PDF compression
Overview of available compressors
| filetype | compressor | lossless | default options |
|----------|------------|----------|---------------------------------------|
| png | pngquant | no | speed = 4, dither = FALSE |
| png | pngcrush | yes | brute = FALSE |
| png | optipng | yes | level = 1 |
| png | zopflipng | yes | lossy_alpha = FALSE, lossy_8bit = FALSE, more = FALSE, insane = FALSE |
| jpeg | jpegoptim | optional | quality = NULL, size = NULL (i.e. lossless) |
| pdf | pdfopt | no | quality = 'screen' |
Sample Plot
ggplot(mtcars) +
geom_density(aes(mpg, fill = as.factor(cyl))) +
theme_gray(15)
dpi <- 72
ggsave("man/figures/png-orig.png", p, width = 6, height = 4)
ggsave("man/figures/jpg-orig.jpg", p, width = 6, height = 4)
ggsave("man/figures/pdf-orig.pdf", p, width = 6, height = 4)
Example: Optimizing PNG output
r1 <- pngquant (infile = "man/figures/png-orig.png", outfile = "man/figures/png-pngquant.png" , verbosity = 1)
r2 <- pngcrush (infile = "man/figures/png-orig.png", outfile = "man/figures/png-pngcrush.png" , verbosity = 1)
r3 <- optipng (infile = "man/figures/png-orig.png", outfile = "man/figures/png-optipng.png" , verbosity = 1)
r4 <- zopflipng(infile = "man/figures/png-orig.png", outfile = "man/figures/png-zopflipng.png", verbosity = 1)
Orig PNG
pngquant - space saving `r round(r1$space_saving * 100)`%
pngcrush - space saving `r round(r2$space_saving * 100)`%
optipng - space saving `r round(r3$space_saving * 100)`%
zopflipng - space saving `r round(r4$space_saving * 100)`%
Example: Optimizing JPEG output
------------------------------------------------------------------------------
wzxhzdk:5
Orig JPG
.
jpegoptim - lossless
Space saving `r round(r5$space_saving * 100)`%
jpegoptim - target size 50kB
Space saving `r round(r6$space_saving * 100)`%
jpegoptim - target quality 10
Space saving `r round(r7$space_saving * 100)`%
Example: Optimizing PDF output
------------------------------------------------------------------------------
wzxhzdk:6
Orig PDF
.
pdfopt
Space saving `r round(r8$space_saving * 100)`%
Speed
------------------------------------------------------------------------------
Most optimizers run in reasonable time i.e. ~1 second for a single file.
`zopflipng` is the exception and with higher compression options you will see
the heat death of the universe before you will see it finish. Even at its lowest
settings (the default) it will take tens-of-seconds up to several minutes to
compress a file. **Use with caution!**
coolbutuseless/optout documentation built on Jan. 24, 2022, 12:03 a.m.
knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "100%" ) library(dplyr) library(ggplot2) library(optout) library(withr)
optout - Optimized Graphics Output
This package enables access to some common command-line image optimization and compression tools from within R, with a mostly consistent call interface.
Tools are included for interfacing command line tools for compressing JPG, PNG and PDF files.
My Use Case
The vignettes for ggpattern are huge because of all the image-based examples. I want to be able to optimize and compress the vignette images from within the Rmd files to try and keep the packge under a reasonable size.
Security Warning
This package does a lot of system2() calls with user input. I've
sanitised all user input, but nothing is ever perfect, so in general
this library should not accept input from the internet e.g. as part of a shiny
app.
Installation
You can install the development version from GitHub with:
# install.packages("remotes") remotes::install_github("coolbutuseless/optout")
This package relies on your system having installed the following command line programs. If a particular utility is not installed, the package will still load fine, but you will not be able to use that particular compression type.
- PNG compression
- JPEG compression
- PDF compression
Overview of available compressors
| filetype | compressor | lossless | default options | |----------|------------|----------|---------------------------------------| | png | pngquant | no | speed = 4, dither = FALSE | | png | pngcrush | yes | brute = FALSE | | png | optipng | yes | level = 1 | | png | zopflipng | yes | lossy_alpha = FALSE, lossy_8bit = FALSE, more = FALSE, insane = FALSE | | jpeg | jpegoptim | optional | quality = NULL, size = NULL (i.e. lossless) | | pdf | pdfopt | no | quality = 'screen' |
Sample Plot
ggplot(mtcars) + geom_density(aes(mpg, fill = as.factor(cyl))) + theme_gray(15)
dpi <- 72 ggsave("man/figures/png-orig.png", p, width = 6, height = 4) ggsave("man/figures/jpg-orig.jpg", p, width = 6, height = 4) ggsave("man/figures/pdf-orig.pdf", p, width = 6, height = 4)
Example: Optimizing PNG output
r1 <- pngquant (infile = "man/figures/png-orig.png", outfile = "man/figures/png-pngquant.png" , verbosity = 1) r2 <- pngcrush (infile = "man/figures/png-orig.png", outfile = "man/figures/png-pngcrush.png" , verbosity = 1) r3 <- optipng (infile = "man/figures/png-orig.png", outfile = "man/figures/png-optipng.png" , verbosity = 1) r4 <- zopflipng(infile = "man/figures/png-orig.png", outfile = "man/figures/png-zopflipng.png", verbosity = 1)
Orig PNG
pngquant - space saving `r round(r1$space_saving * 100)`%
pngcrush - space saving `r round(r2$space_saving * 100)`%
optipng - space saving `r round(r3$space_saving * 100)`%
zopflipng - space saving `r round(r4$space_saving * 100)`%
Orig JPG
.
jpegoptim - lossless
Space saving `r round(r5$space_saving * 100)`%
jpegoptim - target size 50kB
Space saving `r round(r6$space_saving * 100)`%
jpegoptim - target quality 10
Space saving `r round(r7$space_saving * 100)`%
Orig PDF
.
pdfopt
Space saving `r round(r8$space_saving * 100)`%
