hypo_anno_pair_split: One paired hamlet legend element with two fills

In k-hench/hypoimg: Provides Hypoplectrus image annotations

One paired hamlet legend element with two fills

Description

hypo_anno_pair_split combines a paired hamlet with a two-colored circle

Usage

hypo_anno_pair_split(
  left,
  right,
  circle_color = NA,
  circle_fill_left = "white",
  circle_fill_right = "lightgray",
  circle_lwd = 0.5,
  plot_names = FALSE,
  plot_name_size = 3,
  font_family = "sans",
  ...
)

Arguments

left	string scalar (manatory), one of the available species
right	string scalar (manatory), one of the available species
circle_color	color scalar (a string, optional), the color of the background circle outline
circle_fill_left	color scalar (a string, optional), the fill of the left background
circle_fill_right	color scalar (a string, optional), the fill of the right background
circle_lwd	numeric scalar (optional), the width of the background circle outline
plot_names	logical scalar (optional), should the species labels be added?
plot_name_size	numeric scalar (optional), the species label size
font_family	string scalar (optional), the species label font family
...	catch all parameter to allow excess parameter through purrr::pmap

Details

The function hypo_anno_pair_split provides the basic building block of the paired hamlet color legend. It combines a paired hamlet annotaion with a background circle which can be coloured using two fills for the two species.

Aditionally, the species labels can be added to the plot.

Available species: "aberrans", "atlahua", "castroaguirrei", "chlorurus", "ecosur", "floridae", "gemma", "gummigutta", "guttavarius", "indigo", "liberte", "maculiferus", "maya", "nigricans", "providencianus", "puella", "randallorum", "tan", "unicolor"

See Also

hypo_anno_single, hypo_anno_flag_pair

Examples

hypo_anno_pair_split(left = 'puella', right = 'indigo',
  circle_color = 'black', plot_names = TRUE)

k-hench/hypoimg documentation built on June 2, 2022, 1:49 a.m.