Merge pull request #117 from krassowski/fix-venn-metadata

Fix metadata order in arrange_venn
krassowski · Apr 25, 2021 · 0554451 · 0554451
2 parents 9701a27 + 7f12cd0
commit 0554451
Show file tree

Hide file tree

Showing 7 changed files with 395 additions and 301 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: ComplexUpset
 Type: Package
 Title: Create Complex UpSet Plots Using 'ggplot2' Components
-Version: 1.2.0
+Version: 1.2.1
 Authors@R: person(
   "Michał", "Krassowski", email = "[email protected]", role = c("aut", "cre"),
   comment = c(ORCID = "0000-0002-9638-7785"))

diff --git a/NEWS.md b/NEWS.md
@@ -1,8 +1,15 @@
+# Version 1.2.1
+
+2021-04-25
+
+Bug fixes:
+- fixed metadata order in data frame returned by `arrange_venn()` function  #116
+
 # Version 1.2.0
 
 2021-04-03
 
-Bux fixes:
+Bug fixes:
 - [critical] fixed display order of labels when using `encode_sets=TRUE` #110
 - encoding of set names will now properly work around name conflicts #110
 

diff --git a/R/venn.R b/R/venn.R
@@ -592,7 +592,7 @@ arrange_venn = function(
 
     }
     iteration = 1
-    prebious_ratios = c()
+    previous_ratios = c()
 
     while (!large_enough) {
 
@@ -609,7 +609,7 @@ arrange_venn = function(
                 # reasonable convergence
                 large_enough = TRUE
             # prevent infinite loops
-            } else if (slots_surplus_ratio < 0.01 || slots_surplus_ratio %in% prebious_ratios) {
+            } else if (slots_surplus_ratio < 0.01 || slots_surplus_ratio %in% previous_ratios) {
                 large_enough = TRUE
             } else {
                 grid_size = new_grid_size
@@ -625,7 +625,7 @@ arrange_venn = function(
             grid_size = as.integer(round(grid_size * factor))
 
         }
-        prebious_ratios = c(slots_surplus_ratio, prebious_ratios)
+        previous_ratios = c(slots_surplus_ratio, previous_ratios)
         iteration = iteration + 1
     }
 
@@ -663,5 +663,5 @@ arrange_venn = function(
         region_coords
     }))
 
-    cbind(new_coords, data[, setdiff(colnames(data), sets)])
-}
+    cbind(new_coords, data[match(rownames(new_coords), rownames(data)), setdiff(colnames(data), sets)])
+}
diff --git a/tests/figs/deps.txt b/tests/figs/deps.txt
@@ -1,3 +1,3 @@
 - vdiffr-svg-engine: 1.0
 - vdiffr: 0.3.3
-- freetypeharfbuzz: 0.2.5
+- freetypeharfbuzz: 0.2.6
diff --git a/tests/figs/examples/example-12-1-highlight-specific-elements-1.svg b/tests/figs/examples/example-12-1-highlight-specific-elements-1.svg
diff --git a/tests/figs/other-visual/metadata-gets-properly-reordered-for-venn-diagrams.svg b/tests/figs/other-visual/metadata-gets-properly-reordered-for-venn-diagrams.svg
diff --git a/tests/testthat/test-other-visual.R b/tests/testthat/test-other-visual.R
@@ -446,3 +446,30 @@ test_that("Labels retain proper order when encoded", {
         )
     )
 })
+
+
+test_that("Metadata gets properly reordered for Venn diagrams", {
+    df = data.frame(
+      name = 1:20,
+      A = 1:20 %% 2 == 0,
+      B = 1:20 %% 3 == 0,
+      C = 1:20 %% 5 == 0
+    )
+
+    # this column is to track which rows have had TRUE in A
+    df$WasA = df$A
+
+    sets = c("A", "B", "C")
+    arr = arrange_venn(df, sets)
+
+    expect_doppelganger(
+        "Metadata gets properly reordered for Venn diagrams",
+        (
+            ggplot(arr)
+            + theme_void()
+            + geom_venn_circle(data=df, sets=sets, size=1)
+            + geom_venn_label_set(df, sets=sets, aes(label=region), outwards_adjust=2.6)
+            + geom_point(aes(x=x, y=y, color=WasA), size=3)
+        )
+    )
+})