TernaryField: Draw a field on an existing ternary plot

View source: R/Ternary.R

TernaryFieldR Documentation

Draw a field on an existing ternary plot

Description

TernaryField() adds the vector field returned by field3logit() to an existing ternary plot generated by Ternary::TernaryPlot().

Usage

TernaryField(
  field,
  ...,
  length = 0.05,
  conf = FALSE,
  npoints = 100,
  conf.args = list()
)

Arguments

field

object of class field3logit as returned by field3logit().

...

other arguments passed to or from other methods.

length

length of the edges of the arrow head (in inches).

conf

if FALSE confidence regions are not drawn, even if available; if TRUE confidence regions are drawn only if available; if a numeric value is passed, confidence regions at the specified confidence level are computed (if not already available) and drawn.

npoints

number of points of the border to be computed for each confidence region.

conf.args

graphical parameters of confidence regions to be passed to Ternary::TernaryPolygon().

Value

An object of class field3logit with confidence regions included, if computed within TernaryField().

See Also

field3logit().

Examples

library(nnet)
data(cross_1year)

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

TernaryPlot()
TernaryField(field0)


plot3logit documentation built on July 19, 2022, 9:07 a.m.