gridpattern-package: gridpattern: 'grid' Pattern Grobs

In gridpattern: 'grid' Pattern Grobs

gridpattern: 'grid' Pattern Grobs

Description

Provides 'grid' grobs that fill in a user-defined area with various patterns. Includes enhanced versions of the geometric and image-based patterns originally contained in the 'ggpattern' package as well as original 'pch', 'polygon_tiling', 'regular_polygon', 'rose', 'text', 'wave', and 'weave' patterns plus support for custom user-defined patterns.

Package options

The following gridpattern options may be set globally via base::options():

ggpattern_array_funcs

Legacy option to set custom “array” pattern functions. Should use register_pattern(kind = "array") instead.

ggpattern_geometry_funcs

Legacy option to set custom “geometry” pattern functions. Should use register_pattern() instead.

ggpattern_res

Set custom raster image resolution (pixels per inch) for certain patterns.

ggpattern_use_R4.1_clipping

If TRUE use the grid clipping path feature introduced in R v4.1.0. If FALSE do a rasterGrob approximation of the clipped pattern. If NULL try to guess an appropriate choice.

ggpattern_use_R4.1_features

If TRUE sets the default for all the other ⁠ggpattern_use_R4.1_*⁠ options arguments to TRUE. If FALSE sets them to FALSE.

ggpattern_use_R4.1_gradients

If TRUE use the grid gradient feature introduced in R v4.1.0. If FALSE do a rasterGrob approximation of the gradient pattern. If NULL try to guess an appropriate choice.

ggpattern_use_R4.1_masks

If TRUE use the grid mask feature introduced in R v4.1.0. If FALSE do a rasterGrob approximation of the masked pattern. If NULL try to guess an appropriate choice.

ggpattern_use_R4.1_patterns

If TRUE use the grid pattern feature introduced in R v4.1.0. Currently only used by a couple of examples.

Note to use the R v4.1.0 features one needs R be (at least) version 4.1 and not all graphic devices support any/all these features. See https://www.stat.auckland.ac.nz/~paul/Reports/GraphicsEngine/definitions/definitions.html for more information on these features.

Author(s)

Maintainer: Trevor L. Davis [e-mail] (ORCID)

Authors:

• Trevor L. Davis [e-mail] (ORCID)

• Mike FC (Code/docs adapted from ggpattern)

Other contributors:

• ggplot2 authors (some utility functions copied from ggplot2) [contributor]

See Also

Useful links:

• https://trevorldavis.com/R/gridpattern/

• https://github.com/trevorld/gridpattern

• Report bugs at https://github.com/trevorld/gridpattern/issues

gridpattern documentation built on Oct. 28, 2026, 5:06 p.m.