ColorKeyTricolore: Ternary Balance Scheme Legend

In jschoeley/tricolore: A Flexible Color Scale for Ternary Compositions

Ternary Balance Scheme Legend

Description

Plot a ternary balance scheme legend.

Usage

ColorKeyTricolore(
  center,
  breaks,
  h_,
  c_,
  l_,
  contrast,
  spread,
  label_as,
  show_center,
  limits = matrix(0:1, nrow = 2, ncol = 3)
)

Arguments

center	Ternary coordinates of the grey-point.
breaks	Number of breaks in the discrete color scale. An integer >1. Values above 99 imply no discretization.
h_	Primary hue of the first ternary element in angular degrees [0, 360].
c_	Maximum possible chroma of mixed colors [0, 200].
l_	Lightness of mixed colors [0, 100].
contrast	Lightness contrast of the color scale [0, 1).
spread	Spread of the color scale around center > 0.
label_as	"pct" for percent-share labels or "pct_diff" for percent-point-difference from center labels.
show_center	Should the center be marked on the legend? (logical)
limits	A 2 by 3 matrix of lower and upper limits for p1, p2 and p3.

Value

A ggtern grob.

Examples

# NOTE: only intended for internal use and not part of the API
tricolore:::ColorKeyTricolore(center = rep(1/3, 3), breaks = 4,
                              h_ = 80, c_ = 140, l_ = 80,
                              contrast = 0.4, spread = 1,
                              label_as = "pct", show_center = FALSE)

jschoeley/tricolore documentation built on May 18, 2024, 10:57 p.m.