plothelper (version 0.1.9)

annotation_shading_polygon: Layer for Drawing a Single Irregular Polygon with Shading Colors

Description

ggplot2::annotation_raster can only draw shading rectangles. However, this function can draw polygons of any shape with shading colors. See the shape argument and the raster argument.

Usage

annotation_shading_polygon(
  shape = data.frame(c(-1, 1, 0), c(0, 0, 1.732)),
  xmin = NULL,
  xmax = NULL,
  ymin = NULL,
  ymax = NULL,
  raster = NULL,
  interpolate = TRUE,
  result_interpolate = TRUE,
  shape_trim = NULL,
  raster_trim = NULL,
  result_trim = NULL,
  result = c("layer", "magick"),
  width = 800,
  height = NULL,
  res = 72
)

Arguments

shape

the polygon can be a data frame (or matrix object, or tbl_df object) with x and y coordinates (that is, with two columns), a plot created by ggplot or an image read into R by magick::image_read. If it is a plot created by ggplot, its axes can be of numeric, discrete or date/datetime type; however, when the type is date/datetime, the plot should not use ggplot2::coord_fixed.

xmin

the left side of the position to put the polygon. When shape is something like a data frame, you do not need to set xmin, xmax, ymin and ymax, for the function will generate these values according to the coordinates in the polygon.

xmax

the right side.

ymin

the bottom side.

ymax

the top side.

raster

the shading colors. It can be a raster object, a matrix of colors, a ggplot plot or an image read into R by magick::image_read.

interpolate

the interpolate argument used by ggplot2::annotation_raster when the raster argument is a matrix or raster.

result_interpolate

whether to interpolate in the final result which is essentially an output of ggplot2::annotation_raster. Default is TRUE.

shape_trim

this argument decides whether to trim edges of shape. It should be a number between 0 and 100. Default is NULL. If it is NULL, no trimming will be done.

raster_trim

whether to trim raster. Most of the time we do want to trim the raster. However, the magick::image_trim function sometimes trims wrongly. So you may want to turn it off. Default is NULL.

result_trim

how to trim the final result. If you find your figure loses some parts, you can try to turn this off. Default is NULL.

result

when it is "layer", the function is a ggplot layer. When it is "magick", the function only create an image.

width

the width which will be passed to magick::image_graph. Most of the time you do not need to modify this. Default is 800. HOWEVER, if the final polygon has fuzzy edges, try to enlarge width to make them look better.

height

the height which will be passed to magick::image_graph. DO SEE Details below to see how to use this parameter.

res

resolution in pixels which will be passed to magick::image_graph. Default is 72.

Details

height can be used in the following ways:

• (1) an integer which will be directly passed to image::graph.

• (2) a character-like integer, e.g., height = "0.5". Suppose width = 400, the height that will be used is 400*0.5 = 200. This effectively prevents the image from becoming too large.

• (3) height = "coord_fixed". the ratio between height and width will be (top-bottom)/(right-left). And top, bottom, right and left are extreme values of shape when the latter is of class data.frame/matrix/gg.

• (4) height = "image". the width and height will be the width and height of raster when raster is a magick object.

• (5) height = NULL, the default. Now height is computed automatically. A ratio is computed first, ratio = (top-bottom)/(right-left). if the ratio is larger than 5 or smaller than 0.2, then height will be width*5 or width*0.2; else, the height will be treated in the same way as in (3) above. If shape is of class gg and it has uses coord_flip(), the height will be automatically adjusted. All these works are needed to prevent the image from becoming too large.

Examples

# NOT RUN {
# Example 1
poly=ellipsexy(-1, 0, a=1, b=1)
m=matrix(rainbow(7))
ggplot()+
	coord_fixed()+
	annotation_shading_polygon(
		poly, raster=m
	)+
	annotation_shading_polygon(
		poly, raster=m, 
		xmin=1, xmax=5, 
		ymin=-1, ymax=1, 
	)
#
# Example 2, only an image
tt=annotation_shading_polygon(
	poly, result="magick", 
	width=280, height=280
)
#
# Example 3, both shape and raster are 
# ggplot plots.
p1=ggplot()+geom_tile(aes(x=1: 5, y=1: 5))
p2=ggplot()+geom_polygon(aes(x=c(0, 1, 1, 0), 
		y=c(0, 0, 1, 1)), fill="red")+theme_void()
ggplot()+coord_fixed()+
	annotation_shading_polygon(
		shape=p1, 
		xmin=1, xmax=10, 
		ymin=1, ymax=5, 
		raster=p2
	)
# }