hypo_anno_pair: One paired hamlet legend element

View source: R/hypoimg_basics.R

hypo_anno_pairR Documentation

One paired hamlet legend element

Description

hypo_anno_pair combines a paired hamlet with a colored circle

Usage

hypo_anno_pair(
  left,
  right,
  circle_color = NA,
  circle_fill = "white",
  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

color scalar (a string, optional), the fill of the background circle

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 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.

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('indigo','puella',
  circle_color = 'black',plot_names = TRUE)


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