added max.overlaps argument

Author: chrismainey

R/draw_plot.R

@@ -30,7 +30,7 @@
 
 draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multiplier,
                      draw_unadjusted, draw_adjusted, target, min_y, max_y, min_x, max_x
-                    , data_type, sr_method, theme, plot_cols){
+                    , data_type, sr_method, theme, plot_cols, max.overlaps){
 
   # Bind variable for NSE
   numerator <- denominator <- number.seq <- ll95 <- ul95 <- ll998 <- ul998 <- odll95 <- odul95 <-
@@ -149,7 +149,7 @@ draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multip
         geom_label_repel(aes(label = ifelse(highlight == 1,
                                             as.character(group), NA))
                          , size=2.5, point.padding=0, direction = "both", force = 2
-                         , min.segment.length=0, na.rm=TRUE)
+                         , min.segment.length=0, na.rm=TRUE, max.overlaps = max.overlaps)
     }
 
     if(draw_adjusted == FALSE & draw_unadjusted == FALSE){
@@ -164,7 +164,7 @@ draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multip
         geom_label_repel(aes(label = ifelse(outlier == 1,
                                             as.character(group), NA))
                          , size=2.5, point.padding=0, direction = "both", force = 2
-                         , min.segment.length=0, na.rm=TRUE)
+                         , min.segment.length=0, na.rm=TRUE, max.overlaps = max.overlaps)
     }
 
     if(label=="outlier_lower"){
@@ -173,7 +173,7 @@ draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multip
         geom_label_repel(aes(label = ifelse(outlier == 1 & rr < 1,
                                             as.character(group), NA))
                          , size=2.5,point.padding=0, direction = "both", force = 2
-                         , min.segment.length=0, na.rm=TRUE)
+                         , min.segment.length=, na.rm=TRUE, max.overlaps = max.overlaps)
     }
 
     if(label=="outlier_upper"){
@@ -182,7 +182,7 @@ draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multip
         geom_label_repel(aes(label = ifelse(outlier ==  1 & rr > 1,
                                             as.character(group), NA))
                          , size=2.5, point.padding=0, direction = "both", force = 2
-                         , min.segment.length=0, na.rm=TRUE)
+                         , min.segment.length=1, na.rm=TRUE, max.overlaps = max.overlaps)
     }
 
 
@@ -191,7 +191,7 @@ draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multip
         geom_label_repel(aes(label = ifelse((highlight == 1 | outlier == 1) ,
                                             as.character(group), NA))
                          , size=2.5, point.padding=0, direction = "both", force = 2
-                         , min.segment.length=0, na.rm=TRUE)
+                         , min.segment.length=1, na.rm=TRUE, max.overlaps = max.overlaps)
 
     }
 
@@ -200,7 +200,7 @@ draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multip
         geom_label_repel(aes(label = ifelse((highlight == 1 | (outlier == 1& rr < 1)) ,
                                             as.character(group), NA))
                          , size=2.5, point.padding=0, direction = "both", force = 2
-                         , min.segment.length=0, na.rm=TRUE)
+                         , min.segment.length=1, na.rm=TRUE, max.overlaps = max.overlaps)
 
     }
 
@@ -209,7 +209,7 @@ draw_plot<-function(mod_plot_agg, limits, x_label, y_label, title, label, multip
         geom_label_repel(aes(label = ifelse((highlight == 1 | (outlier == 1 & rr > 1)) ,
                                             as.character(group), NA))
                          , size=2.5, point.padding=0, direction = "both", force = 2
-                         , min.segment.length=0, na.rm=TRUE)
+                         , min.segment.length=1, na.rm=TRUE, max.overlaps = max.overlaps)
 
     }
   }

R/funnel_plot.R

@@ -48,6 +48,7 @@
 #' Default has been chosen to avoid red and green which can lead to subconscious value judgements of good or bad.
 #' Default is hex colours: c("#FF7F0EFF", "#FF7F0EFF", "#1F77B4FF","#1F77B4FF", "#9467BDFF", "#9467BDFF", "#2CA02CFF", "#2CA02CFF")
 #' @param SHMI_rounding TRUE/FALSE, for SHMI calculation (standardised ratio, with SHMI truncation etc.), should you round the expected values to 2 decimal places (TRUE) or not (FALSE)
+#' @param max.overlaps 	Exclude text labels that overlap too many things. Defaults to 10. (inheritted from geom_label_repel)
 #'
 #'
 #' @return A fitted `funnelplot` object.  A `funnelplot` object is a list containing the following components:\cr
@@ -127,7 +128,8 @@ funnel_plot <- function(.data, numerator, denominator, group
                         , theme = funnel_clean()
                         , label_outliers, Poisson_limits, OD_adjust
                         , xrange, yrange
-                        , SHMI_rounding = TRUE){
+                        , SHMI_rounding = TRUE
+                        , max.overlaps = 10){
 
   # Version 0.4 deprecation warnings
   if (!missing(label_outliers)) {
@@ -380,7 +382,7 @@ funnel_plot <- function(.data, numerator, denominator, group
                       multiplier=multiplier,
                       draw_unadjusted=draw_unadjusted, draw_adjusted=draw_adjusted,
                       target=target, min_y, max_y, min_x, max_x, data_type=data_type,
-                      sr_method = sr_method, theme = theme, plot_cols=plot_cols)
+                      sr_method = sr_method, theme = theme, plot_cols=plot_cols, max.overlaps = max.overlaps)
 
 
   # Subset outliers for reporting