ggtern: geom_tri_tern – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

geom_tri_tern

Tribin (ggtern version).

Description

Divides the plane into regular triangles, counts the number of cases in each triangles, and then (by default) maps the number of cases to the triangle fill.

Usage

geom_tri_tern(mapping = NULL, data = NULL, stat = "tri_tern",
  position = "identity", ..., fun = sum, na.rm = FALSE,
  show.legend = NA, inherit.aes = TRUE)

stat_tri_tern(mapping = NULL, data = NULL, geom = "tri_tern",
  position = "identity", ..., bins = 30, fun = sum,
  centroid = FALSE, na.rm = FALSE, show.legend = NA,
  inherit.aes = TRUE)

Arguments

`mapping`	Set of aesthetic mappings created by `aes()` or `aes_()`. If specified and `inherit.aes = TRUE` (the default), it is combined with the default mapping at the top level of the plot. You must supply `mapping` if there is no plot mapping.
`data`	The data to be displayed in this layer. There are three options: If `NULL`, the default, the data is inherited from the plot data as specified in the call to `ggplot()`. A `data.frame`, or other object, will override the plot data. All objects will be fortified to produce a data frame. See `fortify()` for which variables will be created. A `function` will be called with a single argument, the plot data. The return value must be a `data.frame`, and will be used as the layer data. A `function` can be created from a `formula` (e.g. `~ head(.x, 10)`).
`position`	Position adjustment, either as a string, or the result of a call to a position adjustment function.
`...`	Other arguments passed on to `layer()`. These are often aesthetics, used to set an aesthetic to a fixed value, like `colour = "red"` or `size = 3`. They may also be parameters to the paired geom/stat.
`fun`	the scalar function to use for the statistic
`na.rm`	If `FALSE`, the default, missing values are removed with a warning. If `TRUE`, missing values are silently removed.
`show.legend`	logical. Should this layer be included in the legends? `NA`, the default, includes if any aesthetics are mapped. `FALSE` never includes, and `TRUE` always includes. It can also be a named logical vector to finely select the aesthetics to display.
`inherit.aes`	If `FALSE`, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. `borders()`.
`geom, stat`	Override the default connection between 'geom_hex_tern' and 'stat_hex_tern'
`bins`	numeric vector giving number of bins in both vertical and horizontal directions. Set to 30 by default.
`centroid`	logical to return the centroid of the polygon, rather than the complete polygon

Aesthetics

@section Aesthetics: geom_hex()understands the following aesthetics (required aesthetics are in bold):

x
y
alpha
colour
fill
group
linetype
size

Learn more about setting these aesthetics in vignette("ggplot2-specs").

Examples

set.seed(1)
n  = 1000
df = data.frame(x  = runif(n),
                y  = runif(n),
                z  = runif(n),
                wt = runif(n))
#Equivalent of Hexbin
ggtern(df,aes(x,y,z)) + 
   geom_tri_tern(bins=10,aes(fill=..count..)) + 
   geom_point(size=0.25)

#Custom Function, Mean
ggtern(df,aes(x,y,z)) + 
   geom_tri_tern(bins=5,aes(fill=..stat..,value=wt),fun=mean) + 
   geom_point(size=0.25)

ggtern

An Extension to 'ggplot2', for the Creation of Ternary Diagrams

v3.3.0

GPL-2 | file LICENSE

Authors

Nicholas Hamilton [aut, cre]

Initial release

2020-04-9