Merge pull request #146 from tdhock/warn-no-key

warn for geoms with showSelected=duration var but no key
tdhock · May 8, 2016 · 6b1c9e5 · 6b1c9e5
2 parents 34ff74e + 2c575fc
commit 6b1c9e5
Show file tree

Hide file tree

Showing 10 changed files with 316 additions and 38 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: animint
 Maintainer: Toby Dylan Hocking <[email protected]>
 Author: Toby Dylan Hocking, Susan VanderPlas, Carson Sievert, Kevin Ferris, Tony Tsai
-Version: 2016.05.07
+Version: 2016.05.08
 License: GPL-3
 Title: Interactive animations
 Description: An interactive animation can be defined using a list of

diff --git a/NEWS b/NEWS
@@ -180,6 +180,14 @@ RENDER: multiple animints inside of a single shiny app? This is
 probably just a theoretical issue. (why not just make a single
 animint?)
 
+2016.05.08 PR#146
+
+GGPLOT: the compiler now stops with an informative error when stats
+are used with showSelected. New warning when position is used with
+showSelected.
+
+RENDER: aes(href) works when data_is_object (e.g. geom_polygon)
+
 2016.05.07 PR#151
 
 BUGFIX: common chunk data were not computed correctly when some chunks

diff --git a/R/animint.R b/R/animint.R
@@ -395,6 +395,7 @@ saveLayer <- function(l, d, meta){
   ## plot.Selectors.
 
   s.aes <- selector.aes(g$aes)
+  meta$selector.aes[[g$classed]] <- s.aes
 
   ## Do not copy group unless it is specified in aes, and do not copy
   ## showSelected variables which are specified multiple times.
@@ -486,19 +487,30 @@ saveLayer <- function(l, d, meta){
     }
   }
 
-  ## Warn if stat_bin is used with animint aes. geom_bar + stat_bin
-  ## doesn't make sense with clickSelects/showSelected, since two
+  not.identity <- function(stat.or.position){
+    x <- stat.or.position$objname
+    is.character(x) && length(x)==1 && x != "identity"
+  }
+  is.show <- grepl("showSelected", names(g$aes))
+  has.show <- any(is.show)
+  ## Error if non-identity stat is used with showSelected, since
+  ## typically the stats will delete the showSelected column from the
+  ## built data set. For example geom_bar + stat_bin doesn't make
+  ## sense with clickSelects/showSelected, since two
   ## clickSelects/showSelected values may show up in the same bin.
-  stat <- l$stat
-  if(!is.null(stat)){
-    is.bin <- stat$objname=="bin"
-    is.animint.aes <- grepl("clickSelects|showSelected", names(g$aes))
-    if(is.bin & any(is.animint.aes)){
-      warning(paste0("stat_bin is unpredictable ",
-                    "when used with clickSelects/showSelected.\n",
-                     "Use plyr::ddply() to do the binning ",
-                     "or use make_bar if using geom_bar/geom_histogram."))
-    }
+  if(has.show && not.identity(l$stat)){
+    show.names <- names(g$aes)[is.show]
+    data.has.show <- show.names %in% names(g.data)
+    signal <- if(all(data.has.show))warning else stop
+    print(l)
+    signal("showSelected only works with stat=identity, problem: ",
+           g$classed)
+  }
+  ## Warn if non-identity position is used with animint aes. 
+  if(has.show && not.identity(l$position)){
+    print(l)
+    warning("showSelected only works with position=identity, problem: ",
+            g$classed)
   }
 
   ##print("before pre-processing")
@@ -893,7 +905,8 @@ saveLayer <- function(l, d, meta){
   }
 
   ## group should be the last thing in nest_order, if it is present.
-  if("group" %in% names(g$aes)){
+  data.object.geoms <- c("line", "path", "ribbon", "polygon")
+  if("group" %in% names(g$aes) && g$geom %in% data.object.geoms){
     g$nest_order <- c(g$nest_order, "group")
   }
 
@@ -1405,6 +1418,24 @@ animint2dir <- function(plot.list, out.dir = tempfile(),
       as.list(unique(unlist(lapply(values.update, "[[", "update"))))
   }
 
+  ## Now that selectors are all defined, go back through geoms to
+  ## check if there are any warnings to issue.
+  for(g.name in names(meta$geoms)){
+    g.info <- meta$geoms[[g.name]]
+    g.selectors <- meta$selector.aes[[g.name]]
+    show.vars <- g.info$aes[g.selectors$showSelected$one]
+    duration.vars <- names(meta$duration)
+    show.with.duration <- show.vars[show.vars %in% duration.vars]
+    no.key <- ! "key" %in% names(g.info$aes)
+    if(length(show.with.duration) && no.key){
+      warning(
+        "to ensure that smooth transitions are interpretable, ",
+        "aes(key) should be specifed for geoms with aes(showSelected=",
+        show.with.duration[1],
+        "), problem: ", g.name)
+    }
+  }
+
   ## For a static data viz with no interactive aes, no need to check
   ## for trivial showSelected variables with only 1 level.
   if(0 < length(meta$selectors)){

diff --git a/inst/examples/breakpoints.R b/inst/examples/breakpoints.R
@@ -29,5 +29,5 @@ breakpointError <-
          geom_line(aes(segments, error, group=bases.per.probe,
                        clickSelects=bases.per.probe),
                    data=only.error, lwd=4))
-gg2animint(breakpointError)
+animint2dir(breakpointError)
 
diff --git a/inst/htmljs/animint.js b/inst/htmljs/animint.js
@@ -1132,7 +1132,7 @@ var animint = function (to_select, json_file) {
       }
     }
 
-    var eActions, eAppend;
+    var eActions, eAppend, linkActions;
     var key_fun = null;
     var id_fun = function(d){
       return d.id;
@@ -1246,6 +1246,17 @@ var animint = function (to_select, json_file) {
 	      return one_row.id;
       };
       elements = elements.data(kv, key_fun);
+      linkActions = function(a_elements){
+	a_elements
+	  .attr("xlink:href", function(group_info){
+            var one_group = keyed_data[group_info.value];
+            var one_row = one_group[0];
+	    return one_row.href;
+	  })
+          .attr("target", "_blank")
+          .attr("class", "geom")
+	;
+      };
       eActions = function (e) {
         e.attr("d", function (d) {
           var one_group = keyed_data[d.value];
@@ -1294,7 +1305,14 @@ var animint = function (to_select, json_file) {
           });
       };
       eAppend = "path";
-    } else if (g_info.geom == "segment") {
+    }else{
+      linkActions = function(a_elements){
+	a_elements.attr("xlink:href", function(d){ return d.href; })
+          .attr("target", "_blank")
+          .attr("class", "geom");
+      };
+    }
+    if (g_info.geom == "segment") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("x1", function (d) {
@@ -1314,7 +1332,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "line";
-    } else if (g_info.geom == "linerange") {
+    }
+    if (g_info.geom == "linerange") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("x1", function (d) {
@@ -1334,7 +1353,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "line";
-    } else if (g_info.geom == "vline") {
+    }
+    if (g_info.geom == "vline") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("x1", toXY("x", "xintercept"))
@@ -1346,7 +1366,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "line";
-    } else if (g_info.geom == "hline") {
+    }
+    if (g_info.geom == "hline") {
       // pretty much a copy of geom_vline with obvious modifications
       elements = elements.data(data, key_fun);
       eActions = function (e) {
@@ -1359,7 +1380,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "line";
-    } else if (g_info.geom == "text") {
+    }
+    if (g_info.geom == "text") {
       elements = elements.data(data, key_fun);
       // TODO: how to support vjust? firefox doensn't support
       // baseline-shift... use paths?
@@ -1375,7 +1397,8 @@ var animint = function (to_select, json_file) {
           });
       };
       eAppend = "text";
-    } else if (g_info.geom == "point") {
+    }
+    if (g_info.geom == "point") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("cx", toXY("x", "x"))
@@ -1385,7 +1408,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "circle";
-    } else if (g_info.geom == "jitter") {
+    }
+    if (g_info.geom == "jitter") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("cx", toXY("x", "x"))
@@ -1395,7 +1419,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "circle";
-    } else if (g_info.geom == "tallrect") {
+    }
+    if (g_info.geom == "tallrect") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("x", toXY("x", "xmin"))
@@ -1410,7 +1435,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "rect";
-    } else if (g_info.geom == "widerect") {
+    }
+    if (g_info.geom == "widerect") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("y", toXY("y", "ymax"))
@@ -1425,7 +1451,8 @@ var animint = function (to_select, json_file) {
           .style("stroke", get_colour);
       };
       eAppend = "rect";
-    } else if (g_info.geom == "rect") {
+    }
+    if (g_info.geom == "rect") {
       elements = elements.data(data, key_fun);
       eActions = function (e) {
         e.attr("x", toXY("x", "xmin"))
@@ -1444,7 +1471,8 @@ var animint = function (to_select, json_file) {
         }
       };
       eAppend = "rect";
-    } else if (g_info.geom == "boxplot") {
+    }
+    if (g_info.geom == "boxplot") {
 
       // TODO: currently boxplots are unsupported (we intentionally
       // stop with an error in the R code). The reason why is that
@@ -1524,16 +1552,9 @@ var animint = function (to_select, json_file) {
           .style("stroke-width", get_size)
           .style("stroke", get_colour);
       };
-    } else {
-      return "unsupported geom " + g_info.geom;
     }
     elements.exit().remove();
     var enter = elements.enter();
-    var linkActions = function(a_elements){
-      a_elements.attr("xlink:href", function(d){ return d.href; })
-        .attr("target", "_blank")
-        .attr("class", "geom");
-    };
     if(g_info.aes.hasOwnProperty("href")){
       enter = enter.append("svg:a")
         .append("svg:"+eAppend);
@@ -1960,7 +1981,7 @@ var animint = function (to_select, json_file) {
     // add a button to view the animation widgets
     var show_hide_animation_controls = element.append("button")
       .text(show_message)
-      .attr("id", "show_hide_animation_controls")
+      .attr("id", viz_id + "_show_hide_animation_controls")
       .on("click", function(){
         if(this.textContent == show_message){
           time_table.style("display", "");
@@ -2027,7 +2048,7 @@ var animint = function (to_select, json_file) {
     var duration_inputs = duration_tds
       .append("input")
       .attr("id", function(s_name){
-        return "duration_ms_" + s_name;
+        return viz_id + "_duration_ms_" + s_name;
       })
       .attr("type", "text")
       .on("change", function(s_name){