,
Alkek Center for Metagenomics and Microbiome Research [cph, fnd]| Title: | Patterned Fills for 'ggplot2' and 'grid' Graphics |
|---|---|
| Description: | Adds distinctive yet unobtrusive geometric patterns where solid color fills are normally used. Patterned figures look just as professional when viewed by colorblind readers or when printed in black and white. The dozen included patterns can be customized in terms of scale, rotation, color, fill, line type, and line width. Compatible with the 'ggplot2' package as well as 'grid' graphics. |
| Authors: | Daniel P. Smith [aut, cre] ,
Alkek Center for Metagenomics and Microbiome Research [cph, fnd] |
| Maintainer: | Daniel P. Smith <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.0.2 |
| Built: | 2025-01-20 04:10:26 UTC |
| Source: | https://github.com/cmmr/fillpattern |
Patterned Fills for Grobs
fill_pattern( patterns = "brick", fg = "black", bg = "transparent", angle = 0, width = 5, height = NA, lwd = 1, lty = "solid", fun = NULL, min_size = 2 ) fillPatternGrob( pattern = "brick", fg = "black", bg = "transparent", angle = 0, width = 5, height = NA, lwd = 1, lty = "solid", fun = NULL, min_size = 2 )fill_pattern( patterns = "brick", fg = "black", bg = "transparent", angle = 0, width = 5, height = NA, lwd = 1, lty = "solid", fun = NULL, min_size = 2 ) fillPatternGrob( pattern = "brick", fg = "black", bg = "transparent", angle = 0, width = 5, height = NA, lwd = 1, lty = "solid", fun = NULL, min_size = 2 )
patterns, pattern
|
The pattern specification. Options are |
fg |
Foreground color, for the pattern's lines. Default: |
bg |
Background color (or grob). Default: |
angle |
How much the rotate the pattern, given in degrees clockwise.
Default: |
width |
The width of the pattern tile. Assumed to be millimeters
unless set otherwise with |
height |
The height of the pattern tile, or |
lwd |
Line width. A positive number.
See |
lty |
Line type. One of |
fun |
A function for modifying graphical parameters immediately
before rendering. Should accept two parameters: |
min_size |
Minimum size of the pattern to draw. Applies to both width
and height. Useful for avoiding CPU and memory overhead on tiny
graphical elements. Assumed to be millimeters unless set otherwise
with |
fillPatternGrob() expects a single value for each parameter.
fill_pattern() can accept a vector of values for each parameter
which are subset or recycled as needed to obtain the same number as
length(patterns).
fill_pattern() returns a list of grid::pattern() objects;
fillPatternGrob() returns a grid::gTree() object.
Base name:
Pattern names must always begin with one of "brick", "chevron",
"fish", "grid", "herringbone", "hexagon", "octagon", "rain",
"saw", "shingle", "rshingle", "stripe", or "wave".
These names support partial matching, e.g. "her", "herring", and
"herringbone" are all valid. However, tiling designs may be added in
the future, so it is recommended to use the full names in finished code.
Angle modifier:
A number immediately following the tiling design, such as "stripe45",
"fish180", or "saw20".
Is added to the angle argument; fill_pattern("brick45", angle=45) is
equivalent to fill_pattern("brick90").
Width and height modifier:
An underscore followed by a single size to be used for both width and height.
Or, an underscore followed by the new width and height separated by a colon.
Can be absolute sizes ("grid_4" or "hex_5mm:0.1npc") or relative to
the width and height arguments ("saw_sm" or "brick_*2:/2"). The
shorthand values "xs", "sm", "md", "lg", and "xl" are equivalent
to "/4", "/2", "1", "*2", and "*4", respectively.
Line width and style:
An underscore, followed by a number, followed by one of "solid",
"dashed", "dotted", "dotdash", "longdash", or "twodash". For
example, "shingle_0.5dashed" or "wave_2solid".
The number component is optional, so "oct_longdash" is also valid, and
will use lwd for the line width.
To specify just the line width, suffix the number with "lwd":
"grid_2lwd" will use lty for the line style.
Combinations:
Modifiers can be combined in any order. For example, "hex_lg:xl_2dotted"
or "grid45_dashed_1.4lwd_:6mm_sm:".
scale_fill_pattern() for ggplot2 integration.
library(grid) library(fillpattern) grid.newpage() grid.rect(gp = gpar(fill = fill_pattern("brick", bg = "gray", angle = 90))) grid.newpage() gp <- Map(gpar, fill = fill_pattern( patterns = c("grid_3lwd", "stripe_longdash", "herringbone45", "hexagon_lg"), fg = c("black", "white", "black", "blue"), bg = c("white", "black", "cyan", "beige") )) grid.circle( gp = gp[[1]], x = 1/4, y = 3/4, r = 1/5) grid.polygon(gp = gp[[2]], x = c(9,12,15)/16, y = c(15,9,15)/16) grid.rect( gp = gp[[3]], x = 1/4, y = 1/4, width = 2/5, height = 2/5) grid.rect( gp = gp[[4]], x = 3/4, y = 1/4, width = 2/5, height = 2/5)library(grid) library(fillpattern) grid.newpage() grid.rect(gp = gpar(fill = fill_pattern("brick", bg = "gray", angle = 90))) grid.newpage() gp <- Map(gpar, fill = fill_pattern( patterns = c("grid_3lwd", "stripe_longdash", "herringbone45", "hexagon_lg"), fg = c("black", "white", "black", "blue"), bg = c("white", "black", "cyan", "beige") )) grid.circle( gp = gp[[1]], x = 1/4, y = 3/4, r = 1/5) grid.polygon(gp = gp[[2]], x = c(9,12,15)/16, y = c(15,9,15)/16) grid.rect( gp = gp[[3]], x = 1/4, y = 1/4, width = 2/5, height = 2/5) grid.rect( gp = gp[[4]], x = 3/4, y = 1/4, width = 2/5, height = 2/5)
Patterned Fills for ggplot.
scale_fill_pattern( patterns = seq_len, fg = NA, bg = ifelse(is.na(fg), "transparent", NA), fade = ifelse(is.na(fg), 1, 0.6), alpha = 1, angle = 0, width = unit(1/10, "npc"), height = NA, lwd = 1, lty = "solid", fun = NULL, min_size = 2 )scale_fill_pattern( patterns = seq_len, fg = NA, bg = ifelse(is.na(fg), "transparent", NA), fade = ifelse(is.na(fg), 1, 0.6), alpha = 1, angle = 0, width = unit(1/10, "npc"), height = NA, lwd = 1, lty = "solid", fun = NULL, min_size = 2 )
patterns |
A vector of pattern names that will be subset or recycled
as needed to match the levels of the |
fg |
Foreground color for the pattern's lines, or |
bg |
Background color (or grob), or |
fade, alpha
|
Modify the color from the |
angle |
How much the rotate the pattern, given in degrees clockwise.
Default: |
width |
The width of the pattern tile. Assumed to be millimeters
unless set otherwise with |
height |
The height of the pattern tile, or |
lwd |
Line width. A positive number.
See |
lty |
Line type. One of |
fun |
A function for modifying graphical parameters immediately
before rendering. Should accept two parameters: |
min_size |
Minimum size of the pattern to draw. Applies to both width
and height. Useful for avoiding CPU and memory overhead on tiny
graphical elements. Assumed to be millimeters unless set otherwise
with |
All of the parameters can accept a vector of values or a function
that takes n as an argument and returns the value(s) to use. The
values are subset or recycled as needed to obtain the same number
as length(levels(fill)), where fill is the variable defined by
aes(fill = ).
A ggplot2::discrete_scale() object.
Base name:
Pattern names must always begin with one of "brick", "chevron",
"fish", "grid", "herringbone", "hexagon", "octagon", "rain",
"saw", "shingle", "rshingle", "stripe", or "wave".
These names support partial matching, e.g. "her", "herring", and
"herringbone" are all valid. However, tiling designs may be added in
the future, so it is recommended to use the full names in finished code.
Angle modifier:
A number immediately following the tiling design, such as "stripe45",
"fish180", or "saw20".
Is added to the angle argument; fill_pattern("brick45", angle=45) is
equivalent to fill_pattern("brick90").
Width and height modifier:
An underscore followed by a single size to be used for both width and height.
Or, an underscore followed by the new width and height separated by a colon.
Can be absolute sizes ("grid_4" or "hex_5mm:0.1npc") or relative to
the width and height arguments ("saw_sm" or "brick_*2:/2"). The
shorthand values "xs", "sm", "md", "lg", and "xl" are equivalent
to "/4", "/2", "1", "*2", and "*4", respectively.
Line width and style:
An underscore, followed by a number, followed by one of "solid",
"dashed", "dotted", "dotdash", "longdash", or "twodash". For
example, "shingle_0.5dashed" or "wave_2solid".
The number component is optional, so "oct_longdash" is also valid, and
will use lwd for the line width.
To specify just the line width, suffix the number with "lwd":
"grid_2lwd" will use lty for the line style.
Combinations:
Modifiers can be combined in any order. For example, "hex_lg:xl_2dotted"
or "grid45_dashed_1.4lwd_:6mm_sm:".
fill_pattern() for base grid graphics integration.
library(ggplot2) library(fillpattern) ggplot(mpg, aes(x = class, y = hwy, color = class, fill = class)) + geom_boxplot() + scale_fill_pattern() ggplot(mpg, aes(x = drv, y = hwy, color = drv, fill = drv)) + geom_violin() + scale_colour_brewer(palette = "Set1") + scale_fill_pattern(c("brick", "stripe45", "grid45_lg"), fg = "black") ggplot(mpg, aes(x = drv, color = drv, fill = drv)) + geom_bar() + scale_fill_pattern( patterns = c("hex_sm", "brick90_xl", "fish"), lty = c("solid", "twodash", "dotted"), lwd = c(2, 3, 1) ) + theme(legend.key.size = unit(2, 'cm'))library(ggplot2) library(fillpattern) ggplot(mpg, aes(x = class, y = hwy, color = class, fill = class)) + geom_boxplot() + scale_fill_pattern() ggplot(mpg, aes(x = drv, y = hwy, color = drv, fill = drv)) + geom_violin() + scale_colour_brewer(palette = "Set1") + scale_fill_pattern(c("brick", "stripe45", "grid45_lg"), fg = "black") ggplot(mpg, aes(x = drv, color = drv, fill = drv)) + geom_bar() + scale_fill_pattern( patterns = c("hex_sm", "brick90_xl", "fish"), lty = c("solid", "twodash", "dotted"), lwd = c(2, 3, 1) ) + theme(legend.key.size = unit(2, 'cm'))