forked from r-lib/ragg
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
111 lines (89 loc) · 4.33 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# ragg <a href='https://ragg.r-lib.org'><img src='man/figures/logo.png' align="right" height="131.5" /></a>
<!-- badges: start -->
[](https://github.com/r-lib/ragg/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/r-lib/ragg?branch=main)
[](https://cran.r-project.org/package=ragg)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->
This package provides graphic devices for R based on the AGG library developed
by the late Maxim Shemanarev. AGG provides both higher performance and higher
quality than the standard raster devices provided by grDevices. For a comparison
with the default devices, see the
[performance](https://ragg.r-lib.org/articles/ragg_performance.html) and
[quality](https://ragg.r-lib.org/articles/ragg_quality.html) vignettes.
## Installation
The package can be installed from CRAN with `install.packages('ragg')` or, if
the development version is desired, directly from github:
```{r, eval=FALSE}
# install.packages('pak')
pak::pak('r-lib/ragg')
```
## Use
ragg provides drop-in replacements for the png, jpeg, and tiff graphic devices
provided by default from the grDevices packages and can both produce png, jpeg
and tiff files. Notable features, that sets itself apart from the build-in
devices, includes:
- Faster (up to 40% faster than anti-aliased cairo device)
- Direct access to all system fonts
- Advanced text rendering, including support for right-to-left text, emojis, and
font fallback
- High quality anti-aliasing
- High quality rotated text
- Support 16-bit output
- System independent rendering (output from Mac, Windows, and Linux should be
identical)
You can use it like any other device. The main functions are `agg_png()`,
`agg_jpeg()` and `agg_tiff()`, all of which have arguments that closely match
those of the `png()`, `jpeg()` and `tiff()` functions, so switching over should
be easy.
```{r, fig.alt="A scatterplot created with ggplot2 using a fancy non-standard font and mixing in emojis with text"}
library(ragg)
library(ggplot2)
file <- knitr::fig_path('.png')
on_linux <- tolower(Sys.info()[['sysname']]) == 'linux'
fancy_font <- if (on_linux) 'URW Chancery L' else 'Papyrus'
agg_png(file, width = 1000, height = 500, res = 144)
ggplot(mtcars) +
geom_point(aes(mpg, disp, colour = hp)) +
labs(title = 'System fonts — Oh My! 😱') +
theme(text = element_text(family = fancy_font))
invisible(dev.off())
knitr::include_graphics(file)
```
Further, it provides an `agg_capture()` device that lets you access the device
buffer directly from your R session.
```{r, fig.asp=0.5, out.width="70%", out.extra='style="margin-left: 15%;"', fig.alt="A very simple scatterplot captured as raster data and then drawn again"}
cap <- agg_capture(width = 1000, height = 500, res = 144)
plot(1:10, 1:10)
scatter <- cap()
invisible(dev.off())
# Remove margins from raster plotting
par(mai = c(0, 0, 0, 0))
plot(as.raster(scatter))
```
### Use ragg with knitr
knitr supports png output from ragg by setting `dev = "ragg_png"` in the chunk
settings or globally with `knitr::opts_chunk$set(dev = "ragg_png")`.
### Use ragg in RStudio
ragg can be used as the graphic back-end to the RStudio device
(for RStudio >= 1.4) by choosing *AGG* as the backend in the graphics pane in
general options (see screenshot)
```{r, echo=FALSE, fig.cap="Setting ragg as backend in RStudio", fig.alt="A screenshot showing the RStudio Global Options window with focus on the General pane and the Graphics tab. Here it shows AGG is selected as Backend in order to tell RStudio to use ragg"}
knitr::include_graphics("https://i.imgur.com/4XgiPWy.png")
```
## Code of Conduct
Please note that the 'ragg' project is released with a
[Contributor Code of Conduct](https://ragg.r-lib.org/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.