hypo_anno_flag_pair: One paired flag legend element

In k-hench/hypoimg: Provides Hypoplectrus image annotations

One paired flag legend element

Description

hypo_anno_flag_pair combines a paired flag with a colored circle

Usage

hypo_anno_flag_pair(
  left,
  right,
  flag_lwd = 1,
  flag_line_color = NA,
  flag_radius_scale = 1,
  circle_color = NA,
  circle_fill = "white",
  circle_lwd = 0.5,
  plot_names = FALSE,
  plot_name_size = 3,
  font_family = "sans",
  ...
)

Arguments

left	string skalar (manatory), one of the available flags
right	string skalar (manatory), one of the available flags
flag_lwd	numeric skalar (optional), line width of the optional frame of the flag annotation
flag_line_color	color skalar (a string, optional), line width of the optional frame of the flag annotation
flag_radius_scale	numeric skalar (optional), scaling of the optional flag annotation frames diameter
circle_color	color skalar (a string, optional), the color of the background circle outline
circle_fill	color skalar (a string, optional), the fill of the background circle
circle_lwd	numeric skalar (optional), the width of the background circle outline
plot_names	logical skalar (optional), should the species labels be added?
plot_name_size	numeric skalar (optional), the species label size
font_family	string skalar (optional), the species label font family
...	catch all parameter to allow excess parameter through purrr::pmap

Details

The function hypo_anno_flag_pair provides the basic building block of the paired flag color legend. It combines a paired flag annotaion with a background circle which can be coloured.

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

See Also

hypo_anno_flag_single, hypo_anno_pair

Examples

hypo_anno_flag_pair(left= 'belize', right = 'panama',
  flag_lwd = 1, flag_line_color = 'black',
  circle_color = 'black', plot_names = TRUE,
  plot_name_size = 5)

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