Minor fix to border_col argument and updated readme

R/func_pie_charts.R

@@ -74,7 +74,7 @@ add_pie_charts <- function(df, admix_columns, lat_column, lon_column, pie_colour
     cols = pie_colours,
     border = border,
     opacity = opacity,
-    segment_col = border_col
+    border_col = border_col
   ))
 
   # Pie chart size formula
@@ -110,7 +110,7 @@ add_pie_charts <- function(df, admix_columns, lat_column, lon_column, pie_colour
 #' @param cols vector of colours the same length as the number of clusters.
 #' @param border numeric value of zero or greater.
 #' @param opacity numeric value of zero to one.
-#' @param segment_col string denoting colour of pie border.
+#' @param border_col string denoting colour of pie border.
 #'
 #' @return A ggplot object.
 #' @export
@@ -130,7 +130,7 @@ add_pie_charts <- function(df, admix_columns, lat_column, lon_column, pie_colour
 #' build_pie_chart(df, location = "London")
 build_pie_chart <- function(df, location, cols = NULL,
                             border = 0.3, opacity = 1,
-                            segment_col = "black"){
+                            border_col = "black"){
 
   # Subset data.frame by site
   df_site <- subset(df, df$site == location)
@@ -161,7 +161,7 @@ build_pie_chart <- function(df, location, cols = NULL,
       x = ggplot2::unit(0.5, "npc"),
       y = ggplot2::unit(0.5, "npc"),
       r = ggplot2::unit(0.40, "npc"), # Issue #16
-      gp = grid::gpar(col = "black", fill = cluster_col, alpha = opacity, lwd = border+0.4)
+      gp = grid::gpar(col = border_col, fill = cluster_col, alpha = opacity, lwd = border+0.4)
     )
 
     # Plot
@@ -176,7 +176,7 @@ build_pie_chart <- function(df, location, cols = NULL,
     plt <- ggplot2::ggplot(data = df_site)+
       ggplot2::geom_bar(
         ggplot2::aes(x = "", y = !!as.name("value"), fill = !!as.name("cluster")),
-        width = 1, stat = "identity", colour = segment_col,
+        width = 1, stat = "identity", colour = border_col,
         show.legend = FALSE, linewidth = border, alpha = opacity
       )+
       ggplot2::coord_polar(theta = "y")+

README.Rmd

@@ -112,6 +112,7 @@ map2 <- mapmixture(
   boundary = c(xmin=-15, xmax=16, ymin=40, ymax=62),
   pie_size = 1,
   pie_border = 0.3,
+  pie_border_col = "white",
   pie_opacity = 1,
   land_colour = "#d9d9d9",
   sea_colour = "#deebf7",

README.md

@@ -116,6 +116,7 @@ map2 <- mapmixture(
   boundary = c(xmin=-15, xmax=16, ymin=40, ymax=62),
   pie_size = 1,
   pie_border = 0.3,
+  pie_border_col = "white",
   pie_opacity = 1,
   land_colour = "#d9d9d9",
   sea_colour = "#deebf7",