---
title: "Patterns 'gradient', 'ambient', 'plasma' - Parameters and Examples"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Patterns 'gradient', 'ambient', 'plasma' - Parameters and Examples}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
dev = "ragg_png",
fig.width = 8,
fig.height = 6
)
# Can't use {ragg} to save gradient example on CRAN due to UBSAN issue
if (!identical(Sys.getenv("IN_PKGDOWN"), "true")) {
knitr::opts_chunk$set(
dev = "png",
dev.args = list(type = "cairo"),
eval = all(capabilities(c("png", "cairo")))
)
}
```
```{r setup}
suppressPackageStartupMessages({
library("ggplot2")
library("ggpattern")
require("magick", quietly = TRUE)
})
```
## Introduction to the 'gradient', 'ambient', and 'plasma' patterns
* The 'gradient' pattern fills the geom with color gradients.
This pattern either depends on the R package `{magick}`
or a graphics device and version of R that supports the
new R 4.1 gradient feature.
* The 'plasma' pattern uses Imagemagick (`magick`) to generate some
fractal noise arrays which are coloured and used to fill the geom.
This pattern depends on the R package `{magick}`.
* The `{ambient}` package offers a way of creating multiple different types of
noise as a matrix of values. The 'ambient' pattern maps this noise
to a colour gradient between two user-specified colours.
* For more info on these patterns see their `{gridpattern}` documentation:
* [`help("grid.pattern_gradient", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_gradient.html)
* [`help("grid.pattern_plasma", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_plasma.html)
* [`help("grid.pattern_ambient", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_ambient.html)
## Pattern Parameters
| aesthetic | description | default |
|----------------------------|---------------------------------------|-----------|
| `pattern_fill` | Noise colour | 'grey80' |
| `pattern_fill2` | Second colour ('ambient', 'gradient') | '#4169E1' |
| `pattern_scale` | Extra scaling | 1 |
| `pattern_alpha` | Alpha | NA |
| `pattern_type` | Type of noise ('ambient') | 'simplex' |
| `pattern_frequency` | Granularity of features in noise | 0.1 |
| `pattern_aspect_ratio` | Override aspect ratio | NA |
| `pattern_key_scale_factor` | Additional scale factor for legend | 1 |
## Example Data
```{r}
df <- data.frame(
trt = c("a", "b", "c"),
outcome = c(2.3, 1.9, 3.2)
)
```
## Example: `pattern = 'plasma'` - With `pattern_alpha`
```{r plasma, fig.cap="", fig.alt="Example of 'plasma' pattern"}
if (require("magick")) {
ggplot(df, aes(trt, outcome)) +
geom_col_pattern(
aes(
fill = trt,
pattern_fill = trt
),
fill = NA,
pattern = 'plasma',
pattern_alpha = 1,
pattern_scale = 2,
colour = 'black'
) +
theme_bw(15) +
labs(
title = "ggpattern::geom_col_pattern()",
subtitle = "pattern='plasma'"
) +
theme(legend.key.size = unit(1.5, 'cm'))
}
```
```{r plasma2, fig.cap="", fig.alt="Example of 'plasma' pattern with 'pattern_alpha = 0.7'"}
if (require("magick")) {
ggplot(mtcars) +
geom_density_pattern(
aes(
x = mpg,
pattern_fill = as.factor(cyl)
),
pattern = 'plasma',
pattern_alpha = 0.7
) +
theme_bw(15) +
theme(legend.position = 'none') +
labs(
title = "ggpattern::geom_density_pattern()",
subtitle = "pattern='plasma'"
)
}
```
Example: `pattern_type = 'gradient'` - Fade to white
------------------------------------------------------------------------------
```{r gradient, fig.cap="", fig.alt="Example of 'gradient' pattern fade to white"}
if (require("magick")) {
ggplot(df, aes(trt, outcome)) +
geom_col_pattern(
aes(
pattern_fill = trt,
pattern_orientation = trt
),
pattern = 'gradient',
pattern_fill2 = 'white',
colour = 'black'
) +
theme_bw(15) +
labs(
title = "ggpattern::geom_col_pattern()",
subtitle = "pattern = 'gradient'"
) +
theme(
legend.key.size = unit(1.5, 'cm')
)
}
```
Example: `pattern_type = 'gradient'` - Fade to dark blue
------------------------------------------------------------------------------
```{r gradient2, fig.cap="", fig.alt="Example of 'gradient' pattern fade to dark blue"}
if (require("magick")) {
ggplot(df, aes(trt, outcome)) +
geom_col_pattern(
aes(
pattern_fill = trt,
pattern_orientation = trt
),
pattern = 'gradient',
pattern_fill2 = '#445566',
colour = 'black'
) +
theme_bw(15) +
labs(
title = "ggpattern::geom_col_pattern()",
subtitle = "pattern = 'gradient'"
) +
theme(
legend.key.size = unit(1.5, 'cm')
)
}
```
Example: `pattern_type = 'gradient'` - Fade to transparent
------------------------------------------------------------------------------
```{r gradient3, fig.cap="", fig.alt="Example of 'gradient' pattern fade to transparent"}
if (require("magick")) {
ggplot(df, aes(trt, outcome)) +
geom_col_pattern(
aes(
pattern_fill = trt,
pattern_orientation = trt
),
pattern = 'gradient',
pattern_fill2 = NA,
fill = NA,
colour = 'black'
) +
theme_bw(15) +
labs(
title = "ggpattern::geom_col_pattern()",
subtitle = "pattern = 'gradient'"
) +
theme(legend.key.size = unit(1.5, 'cm'))
}
```
## Example: `pattern_type = 'gradient'` - Non-rectangular geom
```{r gradient4, fig.cap="", fig.alt="Example of 'gradient' pattern with a non-rectangular geom"}
if (require("magick")) {
ggplot(mtcars) +
geom_density_pattern(
aes(
x = mpg,
pattern_fill = as.factor(cyl),
pattern_orientation = as.factor(cyl)
),
pattern = 'gradient',
pattern_fill2 = NA,
fill = NA
) +
theme_bw(15) +
labs(
title = "ggpattern::geom_density_pattern()",
subtitle = "pattern = 'gradient'"
) +
theme(legend.key.size = unit(1.5, 'cm'))
}
```
## Example: `pattern_type = 'ambient'
```{r ambient, fig.cap="", fig.alt="Example of 'ambient' pattern"}
if (require("ambient")) {
ggplot(df, aes(trt, outcome)) +
geom_col_pattern(
aes(pattern_fill = trt),
pattern = 'ambient',
pattern_fill2 = 'white',
colour = NA,
fill = NA
) +
theme_bw(15) +
labs(
title = "ggpattern::geom_density_pattern()",
subtitle = "pattern = 'ambient'"
) +
theme(legend.position = 'none')
}
```
```{r ambient2, fig.cap="", fig.alt="Another example of 'ambient' pattern"}
if (require("ambient")) {
ggplot(mtcars) +
geom_density_pattern(
aes(
x = mpg,
pattern_fill = as.factor(cyl),
pattern_fill2 = as.factor(cyl)
),
pattern = 'ambient'
) +
theme_bw(15) +
theme(legend.key.size = unit(2, 'cm')) +
scale_pattern_fill_brewer (palette = 'Accent', direction = 1) +
scale_pattern_fill2_brewer(palette = 'Dark2' , direction = 1) +
labs(
title = "ggpattern::geom_density_pattern()",
subtitle = "pattern = 'ambient'"
)
}
```