eulerr

Area-Proportional Euler and Venn Diagrams with Ellipses

https://github.com/jolars/eulerr

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
2 of 9 committers (22.2%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.8%) to scientific vocabulary

Keywords

euler-diagram r venn-diagram

Last synced: 9 months ago · JSON representation ·

Repository

Area-Proportional Euler and Venn Diagrams with Ellipses

Basic Info

Host: GitHub
Owner: jolars
License: gpl-3.0
Language: R
Default Branch: main
Homepage: https://jolars.github.io/eulerr/
Size: 70.4 MB

Statistics

Stars: 134
Watchers: 5
Forks: 20
Open Issues: 31
Releases: 18

Topics

euler-diagram r venn-diagram

Created almost 10 years ago · Last pushed 10 months ago

Metadata Files

Readme Changelog Funding License Citation

README.Rmd

---
output: github_document
---



```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  dev = "png"
)
```

# eulerr 


[![R-CMD-check](https://github.com/jolars/eulerr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jolars/eulerr/actions/workflows/R-CMD-check.yaml)
[![Coverage Status](https://codecov.io/gh/jolars/eulerr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/jolars/eulerr)
[![CRAN Badge](http://www.r-pkg.org/badges/version/eulerr)](https://cran.r-project.org/package=eulerr)


**eulerr** generates area-proportional Euler diagrams that display set
relationships (intersections, unions, and disjoints) with circles or ellipses.
[Euler diagrams](https://en.wikipedia.org/wiki/Euler_diagram) 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

```{r install_cran, eval = FALSE}
install.packages("eulerr")
```

### Development version

```{r install_github, eval = FALSE}
devtools::install_github("jolars/eulerr")
```

### Shiny app

eulerr is also available as a shiny app hosted at
[eulerr.co](https://eulerr.co).

## Usage

```{r specification}
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,

```{r}
fit$stress
fit$diagError
```

and plot it

```{r plot_method}
plot(fit)
```

Please see [the introductory vignette](https://CRAN.R-project.org/package=eulerr/vignettes/introduction.html)
for a brief introduction or [*eulerr under the hood*](https://CRAN.R-project.org/package=eulerr/vignettes/under-the-hood.html)
for details.

## License

eulerr is open source software, licensed under 
[GPL-3](https://github.com/jolars/eulerr/blob/master/LICENSE).

## Versioning

eulerr uses [semantic versioning](https://semver.org).

## Code of conduct

Please note that this project is released with a
[Contributor Code of Conduct](https://github.com/jolars/eulerr/blob/master/CONDUCT.md).
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](http://www.benfrederickson.com) or Leland Wilkinson's
[venneuler](https://cran.r-project.org/package=venneuler).

Owner

Name: Johan Larsson
Login: jolars
Kind: user
Location: Lund, Sweden
Company: University of Copenhagen

Website: https://jolars.co
Repositories: 169
Profile: https://github.com/jolars

Postdoc in statistics at the Department of Mathematical Sciences, University of Copenhagen

Citation (CITATION.cff)

cff-version: 1.2.0
title: eulerr
version: 7.0.2
date-released: '2024-03-28'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Johan
    family-names: Larsson
    email: johan@jolars.co
    affiliation: University of Copenhagen
    orcid: 'https://orcid.org/0000-0002-4029-5945'
repository-code: 'https://github.com/jolars/eulerr'
keywords:
  - euler diagrams
  - venn diagrams
  - data visualization
  - set visualization
  - R
  - ellipses
license: GPL-3.0
preferred-citation:
  type: conference-paper
  title: >-
    A Case Study in Fitting Area-Proportional {{Euler}}
    Diagrams with Ellipses Using eulerr
  collection-title: Proceedings of international workshop on set visualization and reasoning 2018
  authors:
    - given-names: Johan
      family-names: Larsson
      email: johan@jolars.co
      affiliation: University of Copenhagen
      orcid: 'https://orcid.org/0000-0002-4029-5945'
    - given-names: Peter
      family-names: Gustafsson
      affiliation: Lund University
  year: 2018
  conference:
    name: Set visualization and reasoning 2018
    city: Edinburgh
    country: UK
    date-start: '2018-06-18'
    date-end: '2018-06-18'
  url: 'http://ceur-ws.org/Vol-2116/paper7.pdf'

GitHub Events

Total

Issues event: 1
Watch event: 3
Issue comment event: 2
Push event: 3
Fork event: 1

Last Year

Issues event: 1
Watch event: 3
Issue comment event: 2
Push event: 3
Fork event: 1

Committers

Last synced: about 1 year ago

All Time

Total Commits: 1,354
Total Committers: 9
Avg Commits per committer: 150.444
Development Distribution Score (DDS): 0.123

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Johan Larsson	j**n@o**m	1,188
Johan Larsson	m**l@l**m	87
Johan Larsson	j**n@o**m	59
Johan Larsson	j**n@e**n	14
Florian Privé	f**1@g**m	2
Laurent Gatto	l**0@c**k	1
Dirk Eddelbuettel	e**d@d**g	1
Altair Wei	a**i@o**m	1
Johan Larsson	j**n@i**l	1

Committer Domains (Top 20 + Academic)

ip-172-31-25-251.eu-central-1.compute.internal: 1 debian.org: 1 cam.ac.uk: 1 eulerr.localdomain: 1 larssonjohan.com: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 95
Total pull requests: 12
Average time to close issues: about 1 month
Average time to close pull requests: 18 days
Total issue authors: 65
Total pull request authors: 6
Average comments per issue: 1.93
Average comments per pull request: 1.17
Merged pull requests: 9
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 3
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 3
Pull request authors: 0
Average comments per issue: 1.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

jolars (16)
zx8754 (6)
privefl (3)
g3o2 (2)
greboul (2)
eacgit (2)
marwa38 (2)
jxchong (2)
carlotta-93 (2)
moglideveloper (2)
1900mei (2)
andyjslee (1)
edkerk (1)
TDCasasent (1)
royfrancis (1)

Pull Request Authors

jolars (7)
altairwei (2)
lldelisle (1)
xiaosongz (1)
eddelbuettel (1)
privefl (1)

Top Labels

Issue Labels

enhancement (15) not a bug (11) help wanted (6) bug (5) question (1) unclear (1)

Pull Request Labels

Packages

Total packages: 3
Total downloads:
- cran 3,663 last-month
Total docker downloads: 704

Total dependent packages: 2
(may contain duplicates)
Total dependent repositories: 22
(may contain duplicates)
Total versions: 42
Total maintainers: 1

proxy.golang.org: github.com/jolars/eulerr

Documentation: https://pkg.go.dev/github.com/jolars/eulerr#section-documentation
License: gpl-3.0
Latest release: v7.0.2+incompatible
published about 2 years ago

Versions: 18
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.5%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 10 months ago

cran.r-project.org: eulerr

Area-Proportional Euler and Venn Diagrams with Ellipses

Homepage: https://github.com/jolars/eulerr
Documentation: http://cran.r-project.org/web/packages/eulerr/eulerr.pdf
License: GPL-3
Latest release: 7.0.2
published about 2 years ago

Versions: 18
Dependent Packages: 2
Dependent Repositories: 21
Downloads: 3,663 Last month
Docker Downloads: 704

Rankings

Stargazers count: 3.5%

Forks count: 4.0%

Docker downloads count: 5.3%

Dependent repos count: 6.1%

Average: 6.7%

Downloads: 8.4%

Dependent packages count: 13.3%

Maintainers (1)

johanlarsson@outlook.com

Last synced: 10 months ago

conda-forge.org: r-eulerr

Homepage: https://github.com/jolars/eulerr, https://jolars.github.io/eulerr/
License: GPL-3.0-only
Latest release: 6.1.1
published almost 5 years ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 1

Rankings

Dependent repos count: 24.1%

Stargazers count: 31.7%

Average: 36.1%

Forks count: 37.2%

Dependent packages count: 51.5%

Last synced: 10 months ago

Dependencies

DESCRIPTION cran

R >= 3.3.0 depends
GenSA * imports
Rcpp * imports
grDevices * imports
graphics * imports
grid * imports
polyclip * imports
polylabelr * imports
stats * imports
utils * imports
RConics * suggests
covr * suggests
knitr * suggests
lattice * suggests
pBrackets * suggests
rmarkdown * suggests
spelling * suggests
testthat * suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/pkgdown.yaml actions

JamesIves/github-pages-deploy-action v4.4.1 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite