docs: Add 'Other {gridpattern} Patterns' vignette (#79)

.Rbuildignore

@@ -23,5 +23,6 @@
 ^revdep$
 ^share$
 ^tmp$
+^Rplots.pdf$
 ^vignettes/precompute_vignettes.R$
 ^vignettes/*.Rmd.orig$

.Rbuildignore_CRAN

@@ -33,4 +33,5 @@
 ^vignettes/geom-gallery-geometry.*$
 ^vignettes/gganimate.Rmd$
 ^vignettes/patterns-image.*$
+^vignettes/patterns-other.*$
 ^vignettes/patterns-tilings.*$

.gitignore

@@ -2,6 +2,7 @@
 .Rhistory
 *.Rproj
 .Rproj.user
+Rplots.pdf
 *.swp
 working
 *.txt

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: ggpattern
 Type: Package
 Title: 'ggplot2' Pattern Geoms
-Version: 1.3.2-1
+Version: 1.3.2-2
 Authors@R: c(person("Mike", "FC", role = "aut"),
              person("Trevor L.", "Davis", role = c("aut", "cre"),
                     email = "trevor.l.davis@gmail.com",

NEWS.md

@@ -3,6 +3,7 @@
 ## Bug fixes and minor improvements
 
 * Bumps required version of `{gridpattern}` to v1.4.2 which should fix a bug with patterns sometimes not showing up in the legend with larger `pattern_key_scale_factor` values (#86).
+* New *Other {gridpattern} Patterns* vignette (not included with CRAN version) (#79).
 
 # ggpattern 1.3.1
 

vignettes/patterns-other.Rmd

@@ -0,0 +1,205 @@
+---
+title: "Other {gridpattern} Patterns"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Other {gridpattern} Patterns}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  dev = "ragg_png",
+  fig.width = 7,
+  fig.height = 4
+)
+```
+
+```{r setup}
+suppressPackageStartupMessages({
+  library(ggplot2)
+  library(ggpattern)
+})
+```
+
+## Introduction
+
+Several dedicated `{ggpattern}` vignettes cover many `{gridpattern}` patterns:
+
+```{r covered-list, results="asis", echo=FALSE}
+# Patterns covered in other ggpattern vignettes
+covered <- list(
+  "patterns-stripes" = c("stripe", "crosshatch", "wave", "weave"),
+  "patterns-points" = c("circle", "pch", "regular_polygon", "rose"),
+  "patterns-tilings" = c("polygon_tiling", "magick"),
+  "patterns-image" = c("image", "placeholder"),
+  "patterns-noise" = c("ambient", "plasma", "gradient")
+)
+
+all_patterns <- sub(
+  "^grid\\.pattern_", "",
+  grep("^grid\\.pattern_", ls(getNamespace("gridpattern")), value = TRUE)
+)
+other_patterns <- setdiff(all_patterns, unlist(covered))
+vignette_url <- "https://trevorldavis.com/R/ggpattern/dev/articles"
+lines <- mapply(function(vignette, patterns) {
+  last <- if (length(patterns) >= 3L) ", and " else " and "
+  pats <- glue::glue_collapse(glue::glue("`{patterns}`"), sep = ", ", last = last)
+  glue::glue("* [{vignette}]({vignette_url}/{vignette}.html): {pats}")
+}, names(covered), covered)
+cat(lines, sep = "\n")
+```
+
+The following `{gridpattern}` patterns are not yet featured in such a dedicated `{ggpattern}` vignette:
+
+```{r pattern-list, results="asis", echo=FALSE}
+gridpattern_url <- "https://trevorldavis.com/R/gridpattern/dev/reference"
+links <- glue::glue(
+  "* [`{other_patterns}`]({gridpattern_url}/grid.pattern_{other_patterns}.html)"
+)
+cat(links, sep = "\n")
+```
+
+
+## Data
+
+Standard data used in the example plots below.
+
+```{r}
+df <- data.frame(trt = c("a", "b", "c"), outcome = c(2.3, 1.9, 3.2))
+```
+
+## Pattern 'aRtsy'
+
+The `aRtsy` pattern generates generative art fills powered by the [`{aRtsy}`](https://koenderks.github.io/aRtsy/) package.
+This pattern requires `{aRtsy}` to be installed.  Use `gridpattern::names_aRtsy()` to list all supported types.
+
+For more information see [`help("grid.pattern_aRtsy", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_aRtsy.html).
+
+```{r artsy-example, fig.cap="", fig.alt="Bar chart using the aRtsy pattern", eval=requireNamespace("aRtsy", quietly=TRUE)}
+set.seed(42)
+ggplot(df, aes(trt, outcome)) +
+  geom_col_pattern(
+    aes(pattern_type = trt),
+    pattern = "aRtsy",
+    pattern_fill = "steelblue",
+    colour = "black"
+  ) +
+  scale_pattern_type_manual(values = c("strokes", "maze", "flow")) +
+  theme_bw() +
+  labs(title = "pattern = 'aRtsy'")
+```
+
+## Pattern 'fill'
+
+The `fill` pattern simply fills the area with a solid colour (any `pattern_fill` aesthetic will cover the `fill` aesthetic).
+
+For more information see
+[`help("grid.pattern_fill", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_fill.html).
+
+```{r fill-example, fig.cap="", fig.alt="Bar chart using the fill pattern"}
+ggplot(df, aes(trt, outcome)) +
+  geom_col_pattern(
+    aes(pattern_fill = trt),
+    pattern = "fill",
+    colour = "black"
+  ) +
+  theme_bw() +
+  labs(title = "pattern = 'fill'")
+```
+
+## Pattern 'hatch'
+
+The `hatch` pattern draws heraldic colour hatching.
+Each hatching *type* corresponds to a traditional tincture (e.g. `"gules"` for red, `"azure"` for blue).
+Use `gridpattern::names_hatch()` to list all supported types.
+
+For more information see
+[`help("grid.pattern_hatch", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_hatch.html)
+and [`vignette("hatching", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/articles/hatching.html).
+
+```{r hatch-example, fig.cap="", fig.alt="Bar chart using the hatch pattern with heraldic types"}
+ggplot(df, aes(trt, outcome)) +
+  geom_col_pattern(
+    aes(pattern_color = trt, pattern_type = trt),
+    fill = "white",
+    pattern = "hatch",
+    pattern_subtype = "combinatorial",
+    colour = "black"
+  ) +
+  scale_pattern_type_manual(values = c("gules", "azure", "sable")) +
+  scale_pattern_color_manual(values = c("darkred", "darkblue", "black")) +
+  theme_bw() +
+  labs(title = "pattern = 'hatch'")
+```
+
+## Pattern 'line'
+
+The `line` pattern draws stroked lines using the device's native line
+renderer.  Unlike `stripe` (which fills bands with solid colour), `line`
+honours all of R's built-in `linetype` values — including `"dotdash"`,
+`"twodash"`, and custom hex-string line types.
+
+For more information see
+[`help("grid.pattern_line", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_line.html).
+
+```{r line-example, fig.cap="", fig.alt="Bar chart using the line pattern with varied linetypes"}
+ggplot(df, aes(trt, outcome)) +
+  geom_col_pattern(
+    aes(pattern_linetype = trt),
+    pattern = "line",
+    pattern_colour = "black",
+    pattern_density = 0.5,
+    colour = "black",
+    fill = "white"
+  ) +
+  scale_pattern_linetype_manual(values = c("solid", "dotted", "twodash")) +
+  theme_bw() +
+  labs(title = "pattern = 'line'")
+```
+
+## Pattern 'none'
+
+The `none` pattern renders no pattern overlay.
+
+For more information see
+[`help("grid.pattern_none", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_none.html).
+
+```{r none-example, fig.cap="", fig.alt="Bar chart using the none pattern"}
+ggplot(df, aes(trt, outcome)) +
+  geom_col_pattern(
+    pattern = "none",
+    fill = "steelblue",
+    colour = "black"
+  ) +
+  theme_bw() +
+  labs(title = "pattern = 'none'")
+```
+
+## Pattern 'text'
+
+The `text` pattern tiles the area with repeated text characters or expressions.  
+The character is controlled by `pattern_shape`.
+
+For more information see
+[`help("grid.pattern_text", package = "gridpattern")`](https://trevorldavis.com/R/gridpattern/dev/reference/grid.pattern_text.html).
+
+```{r text-example, fig.cap="", fig.alt="Bar chart using the text pattern with different characters"}
+ggplot(df, aes(trt, outcome)) +
+  geom_col_pattern(
+    aes(fill = trt, pattern_color = trt, pattern_shape = trt),
+    pattern = "text",
+    pattern_size = 12,
+    pattern_spacing = 0.08,
+    pattern_grid = "hex",
+    pattern_angle = 0,
+    colour = "black"
+  ) +
+  scale_fill_manual(values = c("black", "white", "gold")) +
+  scale_pattern_color_manual(values = c("gold", "red", "black")) +
+  scale_pattern_shape_manual(values = c("★", "♥", "♣")) +
+  theme_bw() +
+  labs(title = "pattern = 'text'")
+```

vignettes/patterns-stripes.Rmd

@@ -102,9 +102,8 @@ ggplot(df, aes(trt, outcome)) +
   To get the legend right we'll often want to set them with a pattern scale function
   like 'pattern_scale_manual()' instead of simply setting them with the 'pattern' aesthetic.
 * Here we'll use the 'stripe' pattern and 'wave' pattern.
-* The 'wave' pattern supports two subtypes: 'triangle' waves (default) have a zig-zag appearance
-  whereas 'sine' waves have a curvy appearance.
-
+* The 'wave' pattern supports `r length(gridpattern::names_wave)` subtypes:
+`r glue::glue_collapse(shQuote(gridpattern::names_wave), sep = ", ", last = ", and ")`
 ```{r mixing, fig.cap="", fig.alt="A plot with both a 'stripe' pattern and a 'wave' pattern."}
 ggplot(df, aes(trt, outcome)) +
   geom_col_pattern(aes(fill=trt, pattern=trt, pattern_type=trt),
@@ -114,7 +113,7 @@ ggplot(df, aes(trt, outcome)) +
   labs(title = "Use 'stripe' and 'wave' patterns") +
   theme(legend.key.size = unit(1.5, 'cm')) +
   scale_pattern_manual(values=c('stripe', 'wave', 'wave')) +
-  scale_pattern_type_manual(values=c(NA, 'triangle', 'sine'))
+  scale_pattern_type_manual(values=c(NA, 'indented', 'wavy'))
 ```
 
 ## The Density Aesthetic