error_plot: Error plot for 'euler' objects

In jolars/eulerr: Area-Proportional Euler and Venn Diagrams with Ellipses

Error plot for euler objects

Description

This is a diagnostic tool for evaluating the fit from a call to euler() visually. A color key is provided by default, which represents the chosen error metric so that one can easily detect which areas in the diagram to be skeptical about.

Usage

error_plot(
  x,
  type = c("regionError", "residuals"),
  quantities = TRUE,
  pal = NULL,
  ...
)

Arguments

x	an object of class euler, typically the result of a call to euler().
type	error metric. 'regionError' is the difference in percentage points from the input
quantities	whether to draw the error metric on the plot
pal	color palette for the fills in the legend
...	arguments passed down to plot.euler(). Currently, providing fills, legend, or strips are not allowed and will return a warning.

Details

Notice that this function is purely provided for diagnostic reasons and does not come with the same kind of customization that plot.euler() provides: the color legend can only be customized in regards to its color palette and another key (instead of labels) is completely turned off.

Value

Returns an object of class eulergram, which will be plotted on the device in the same manner as objects from plot.euler(). See plot.eulergram() for details.

See Also

plot.euler(), euler(), plot.eulergram()

Examples

error_plot(euler(organisms), quantities = FALSE)

jolars/eulerr documentation built on April 2, 2024, 11:42 p.m.