stat_3logit: Add a field and confidence regions to a 'gg3logit' plot
In plot3logit: Ternary Plots for Trinomial Regression Models

stat_3logit

R Documentation

Add a field and confidence regions to a `gg3logit` plot

Description

stat_3logit() adds a field and confidence regions to a gg3logit plot. stat_3logit() is a wrapper for stats stat_field3logit() and stat_conf3logit() which are jointly applied.

Usage

stat_3logit(
  mapping_field = aes(),
  mapping_conf = aes(),
  data = NULL,
  params_field = list(),
  params_conf = list(),
  show.legend = NA,
  inherit.aes = TRUE,
  conf = TRUE
)

Arguments

`mapping_field`, `mapping_conf`	aesthetic mappings passed to argument `mapping` of `stat_field3logit()` and `stat_conf3logit()`.
`data`	a `field3logit` object, a `multifield3logit` object, or a `data.frame` structured like a fortified `field3logit` or a `multifield3logit` object.
`params_field`, `params_conf`	graphical parameters passed to argument `mapping` of `stat_field3logit()` and `stat_conf3logit()`.
`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. To include legend keys for all levels, even when no data exists, use `TRUE`. If `NA`, all levels are shown in legend, but unobserved levels are omitted.
`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. `annotation_borders()`.
`conf`	if `TRUE` and if confidence regions are available, the layer of `stat_conf3logit()` is added, otherwise only the layer of `stat_field3logit()` is returned.

Value

If conf is set to FALSE a layer of ggplot package is returned (object of class LayerInstance), otherwise, if conf is set to TRUE, stat_3logit returns a list of two ggplot2 layers (class LayerInstance).

Examples


data(cross_1year)

mod0 <- nnet::multinom(employment_sit ~ gender + finalgrade, data = cross_1year)
field0 <- field3logit(mod0, 'genderFemale', conf = 0.95)

gg3logit(field0) + stat_3logit()
gg3logit(field0) + stat_3logit(conf = TRUE)

plot3logit documentation built on Dec. 20, 2025, 1:07 a.m.