Learn R Programming

eulerr

eulerr generates area-proportional Euler diagrams that display set relationships (intersections, unions, and disjoints) with circles or ellipses. Euler diagrams are Venn diagrams without the requirement that all set interactions be present (whether they are empty or not), which means that, depending on input, eulerr sometimes produces Venn diagrams and sometimes not.

With three or more sets intersecting, exact Euler diagrams are often impossible. For such cases eulerr attempts to provide a good approximation by numerically tuning the parameters of the ellipses or circles to minimize the error in the resulting diagram. Residuals and goodness of fit statistics are provided to assess whether the resulting diagram can be trusted.

Installation

CRAN version

install.packages("eulerr")

Development version

devtools::install_github("jolars/eulerr")

Shiny app

eulerr is also available as a shiny app hosted at eulerr.co.

Usage

library(eulerr)
# From Wilkinson 2012
fit <- euler(c("A" = 4, "B" = 6, "C" = 3, "D" = 2, "E" = 7, "F" = 3,
               "A&B" = 2, "A&F" = 2, "B&C" = 2, "B&D" = 1,
               "B&F" = 2, "C&D" = 1, "D&E" = 1, "E&F" = 1,
               "A&B&F" = 1, "B&C&D" = 1),
             shape = "ellipse")

We can inspect the goodness-of-fit metrics diagError and stress for the solution,

fit$stress
#> [1] 6.27447e-14
fit$diagError
#> [1] 4.418069e-08

and plot it

plot(fit)

Please see the introductory vignette for a brief introduction or eulerr under the hood for details.

License

eulerr is open source software, licensed under GPL-3.

Versioning

eulerr uses semantic versioning.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Acknowledgements

eulerr would not be possible without Ben Frederickson’s work on venn.js or Leland Wilkinson’s venneuler.

Copy Link

Version

Install

install.packages('eulerr')

Monthly Downloads

3,124

Version

7.0.2

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

March 28th, 2024

Functions in eulerr (7.0.2)

setup_gpar

Setup gpars
get_bounding_box

Get the bounding box of an ellipse
print.euler

Print a summary of an Euler diagram
stress

Stress
plot.euler

Plot Euler and Venn diagrams
plot.eulergram

Print (plot) Euler diagram
print.venn

Print a summary of a Venn diagram
poly_clip

Polygon Clipping
n_sets

Get the number of sets in he input
tally_combinations

Tally set relationships
regionError

regionError
normalize_angle

Normalize an angle to [-pi, pi)
replace_list

Replace (refresh) a list
organisms

Organisms
fitted.euler

Fitted values of euler object
setup_grobs

Grobify Euler objects
normalize_pars

Normalize parameters (semiaxes and rotation)
setup_tag

Setup grobs for labels (labels, quantities, percentages)
skyline_pack

Skyline packing algorithm
setup_geometry

Compute geometries and label locations
separate_two_discs

Optimize Distance Between Circles Based On Overlap
rescale

Rescale values to new range
update_list

Update list with input
eulerr_deprecated

Deprecated functions in package eulerr.
venn

Venn diagrams
pain

Pain distribution data
plants

Plants
coef.euler

Return ellipses from the euler object
euler

Area-proportional Euler diagrams
error_plot

Error plot for euler objects
eulerr_options

Get or set global graphical parameters for eulerr
dummy_code

Dummy code a data.frame
compress_layout

Compress an Euler layout
eulerr-package

eulerr: Area-Proportional Euler and Venn Diagrams with Ellipses
is_false

Check if object is strictly FALSE
diagError

diagError
center_layout

Center ellipses
makeContent.EulerTags

Avoid overlap for labels
get_constraints

Set up constraints for optimization
eulerr_default_options

Default options for eulerr
is_integer

Check if a vector is an integer
ellipse

Plotting coordinates for an ellipse
fruits

Fruits
bit_indexr

Binary indices
is_real

Check if vector is a real (numeric non-integer)
mix_colors

Blend (average) colors