Skip to content

Commit

Permalink
docs: Default placeholder is now "bear"
Browse files Browse the repository at this point in the history
* Update vignette to point out default placeholder type
  is now "bear" in upstream `{gridpattern}`
* Recently "kitten" has been a bit buggy but isn't completely down

closes #111
  • Loading branch information
trevorld committed Apr 23, 2024
1 parent 2afcc30 commit 0858b1c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Imports:
ggplot2 (>= 3.5.0),
glue,
grid,
gridpattern (>= 1.2.0),
gridpattern (>= 1.2.0-4),
lifecycle,
rlang,
scales,
Expand Down
6 changes: 3 additions & 3 deletions vignettes/patterns-image.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -342,18 +342,18 @@ while they are developing a new site.

| Aesthetic | Description | Default |
|----------------------------|------------------------------------|-----------|
| `pattern_type` | Image source | 'kitten' |
| `pattern_type` | Image source | 'bear' |
| `pattern_alpha` | Alpha | NA |
| `pattern_aspect_ratio` | Override aspect ratio | NA |
| `pattern_key_scale_factor` | Additional scale factor for legend | 1 |

### `placeholder` option `pattern_type`

The following is a list of all the `pattern_type` values which are valid. If
unspecified or unknown, then `ggpattern` will use `pattern_type = 'kitten'`.
unspecified or unknown, then `ggpattern` will use `pattern_type = 'bear'`.

If you would like only greyscale images, append `bw` to the name, e.g. to
display only black and white kittens use `pattern_type = 'kittenbw'`.
display only black and white bears use `pattern_type = 'bearbw'`.

Click the link to see an example of each placeholder generator

Expand Down
6 changes: 3 additions & 3 deletions vignettes/patterns-image.Rmd.orig
Original file line number Diff line number Diff line change
Expand Up @@ -323,18 +323,18 @@ while they are developing a new site.

| Aesthetic | Description | Default |
|----------------------------|------------------------------------|-----------|
| `pattern_type` | Image source | 'kitten' |
| `pattern_type` | Image source | 'bear' |
| `pattern_alpha` | Alpha | NA |
| `pattern_aspect_ratio` | Override aspect ratio | NA |
| `pattern_key_scale_factor` | Additional scale factor for legend | 1 |

### `placeholder` option `pattern_type`

The following is a list of all the `pattern_type` values which are valid. If
unspecified or unknown, then `ggpattern` will use `pattern_type = 'kitten'`.
unspecified or unknown, then `ggpattern` will use `pattern_type = 'bear'`.

If you would like only greyscale images, append `bw` to the name, e.g. to
display only black and white kittens use `pattern_type = 'kittenbw'`.
display only black and white bears use `pattern_type = 'bearbw'`.

Click the link to see an example of each placeholder generator

Expand Down

0 comments on commit 0858b1c

Please sign in to comment.