hypo_anno_single: One single hamlet legend element

View source: R/hypoimg_basics.R

hypo_anno_singleR Documentation

One single hamlet legend element

Description

hypo_anno_single combines a single hamlet with a colored circle

Usage

hypo_anno_single(
  species,
  circle_color = NA,
  circle_fill = "white",
  circle_lwd = 0.5,
  plot_names = FALSE,
  plot_name_size = 3,
  font_family = "sans",
  xlims = 0.45,
  ylims = 0.335,
  ...
)

Arguments

species

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 label be added?

plot_name_size

numeric scalar (optional), the species label size

font_family

string scalar (optional), the species label font family

xlims

numeric scalar (optional), modifies the horizontal extent of the hamlet

ylims

numeric scalar (optional), modifies the vertical extent of the hamlet

...

catch all parameter to allow excess parameter through purrr::pmap

Details

The function hypo_anno_single provides the basic building block of the single hamlet color legend. It combines a single hamlet annotaion with a background circle which can be coloured.

Aditionally, the species label 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_pair, hypo_anno_flag_single

Examples

hypo_anno_single('indigo',circle_color = 'black',
  plot_names = TRUE)


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