Learn R Programming

⚠️There's a newer version (7.0.4) of this package.Take me there.

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] 0.0001957608
fit$diagError
#> [1] 0.002251973

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

6,720

Version

5.0.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Johan Larsson

Last Published

November 5th, 2018

Functions in eulerr (5.0.0)

bit_indexr

Binary indices
compress_layout

Compress an Euler layout
get_constraints

Set up constraints for optimization
regionError

regionError
stress

Stress
skyline_pack

Skyline packing algorithm
is_false

Check if object is strictly FALSE
organisms

Organisms
pain

Pain distribution data
ellipse

Plotting coordinates for an ellipse
separate_two_discs

Optimize Distance Between Circles Based On Overlap
plants

Plants
plot.euler

Plot area-proportional Euler diagrams
euler

Area-proportional Euler diagrams
setup_gpar

Setup gpars
setup_grobs

Grobify Euler objects
setup_geometry

Compute geometries and label locations
eulerr-package

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

Default options for eulerr
eulerr_deprecated

Deprecated functions in package eulerr.
tally_combinations

Tally set relationships
plot.eulergram

Print (plot) Euler diagram
poly_clip

Polygon Clipping
replace_list

Replace (refresh) a list
rescale

Rescale values to new range
error_plot

Error plot for euler objects
fruits

Fruits
get_bounding_box

Get the bounding box of an ellipse
normalize_angle

Normalize an angle to [-pi, pi)
normalize_pars

Normalize parameters (semiaxes and rotation)
update_list

Update list with input
eulerr_options

Get or set global graphical parameters for eulerr
fitted.euler

Fitted values of euler object
mix_colors

Blend (average) colors
diagError

diagError
n_sets

Get the number of sets in he input
center_layout

Center ellipses
dummy_code

Dummy code a data.frame
coef.euler

Return ellipses from the euler object
print.euler

Print Euler diagram fits