geom_phylopic {rphylopic} | R Documentation |
Geom for adding PhyloPic silhouettes to a plot
Description
This geom acts like ggplot2::geom_point()
, except that the specified
silhouettes are used as points. Silhouettes can be specified by their name
,
uuid
, or image objects (img
).
Usage
geom_phylopic(
mapping = NULL,
data = NULL,
stat = "identity",
position = "identity",
...,
na.rm = FALSE,
show.legend = FALSE,
inherit.aes = TRUE,
remove_background = TRUE,
verbose = FALSE,
filter = NULL
)
Arguments
mapping |
Set of aesthetic mappings created by |
data |
The data to be displayed in this layer. There are three options: If A A |
stat |
The statistical transformation to use on the data for this
layer, either as a |
position |
Position adjustment, either as a string naming the adjustment
(e.g. |
... |
Other arguments passed on to |
na.rm |
If |
show.legend |
logical. Should this layer be included in the legends?
|
inherit.aes |
If |
remove_background |
|
verbose |
|
filter |
|
Details
One (and only one) of the img
, name
, or uuid
aesthetics must
be specified. The img
aesthetic can be
Picture objects or png array objects, e.g.,
from using get_phylopic()
. Use the x
and y
aesthetics to place the
silhouettes at specified positions on the plot. The size
aesthetic
specifies the height of the silhouettes in the units of the y axis. The
aspect ratio of the silhouettes will always be maintained.
The color
(default: NA), fill
(default: "black"), and alpha
(
default: 1) aesthetics can be used to change the outline color, fill color,
and transparency (outline and fill) of the silhouettes, respectively. If
color
is specified and fill
is NA color
will be used as the fill
color (for backwards compatibility). If "original" is specified for the
color
aesthetic, the original color of the silhouette outline will be
used (usually the same as "transparent"). If "original" is specified for
the fill
aesthetic, the original color of the silhouette body will be
used (usually the same as "black"). To remove the fill or outline, you can
set fill
or color
to "transparent", respectively.
The horizontal
and vertical
aesthetics can be used to flip the
silhouettes. The angle
aesthetic can be used to rotate the silhouettes.
When specifying a horizontal and/or vertical flip and a rotation, the
flip(s) will always occur first. If you would like to customize this
behavior, you can flip and/or rotate the image within your own workflow
using flip_phylopic()
and rotate_phylopic()
.
Note that png array objects can only be rotated by multiples of 90 degrees. Also, outline colors do not currently work for png array objects.
Aesthetics
geom_phylopic understands the following aesthetics:
-
x (required)
-
y (required)
-
img/uuid/name (one, and only one, required)
size
color/colour
fill
alpha
horizontal
vertical
angle
Learn more about setting these aesthetics in
add_phylopic()
.
Examples
## Not run:
library(ggplot2)
df <- data.frame(x = c(2, 4), y = c(10, 20),
name = c("Felis silvestris catus", "Odobenus rosmarus"))
ggplot(df) +
geom_phylopic(aes(x = x, y = y, name = name),
fill = "purple", size = 10) +
facet_wrap(~name) +
coord_cartesian(xlim = c(1,6), ylim = c(5, 30))
## End(Not run)