Tweak README to mention masks.

hughjonesd · Jan 31, 2024 · e4d7910 · e4d7910
1 parent 4d3b950
commit e4d7910
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -246,6 +246,15 @@ ggpi +
 
 ## Tips and tricks
 
+### Graphics devices
+
+`geom_magnify()` uses masks. This requires R version 4.1.0 or higher, and a
+graphics device that supports masking. If you are using knitr, you may have
+luck with the `ragg_png` device (which was used to create this README). If your
+device doesn't support masks, only `shape = "rect"` will work, and the plot
+inset will not be clipped to the panel area.
+
+
 ### Adding layers to the inset
 
 `geom_magnify()` stores the plot when it is added to it. So, order matters:

diff --git a/README.md b/README.md
@@ -250,6 +250,14 @@ ggpi +
 
 ## Tips and tricks
 
+### Graphics devices
+
+`geom_magnify()` uses masks. This requires R version 4.1.0 or higher,
+and a graphics device that supports masking. If you are using knitr, you
+may have luck with the `ragg_png` device (which was used to create this
+README). If your device doesn’t support masks, only `shape = "rect"`
+will work, and the plot inset will not be clipped to the panel area.
+
 ### Adding layers to the inset
 
 `geom_magnify()` stores the plot when it is added to it. So, order