find_venn_overlaps_JamPolygon: Find Venn polygon overlaps

In jmw86069/venndir: Directional Venn diagrams

Find Venn polygon overlaps

Description

Find Venn polygon overlaps

Usage

find_venn_overlaps_JamPolygon(
  jp,
  venn_counts = NULL,
  venn_items = NULL,
  venn_colors = NULL,
  sep = "&",
  preset = "dichromat2",
  blend_preset = "ryb",
  do_plot = FALSE,
  verbose = FALSE,
  ...
)

Arguments

jp	JamPolygon that contains one polygon per set, named using set names.
venn_counts	vector with integer values, whose names represent each Venn overlap set combination, using sep as delimiter between set names.
venn_items	list or NULL that contains items in each overlap set.
sep	character string used as a delimiter between set names.
preset, blend_preset	character string passed to colorjam::rainbowJam() and colorjam::blend_colors(), respectively, to define the color hue wheel used for categorical colors, and for color blending. The default preset="dichromat2" chooses color-blindness-friendly categorical colors, and blend_preset="ryb" blends multiple colors using a red-yellow-blue color wheel, consistent with paint-type color combinations.
do_plot	logical indicating whether to plot the output SpatialPolygonsDataFrame object.
verbose	logical indicating whether to print verbose output.
...	additional arguments are passed to supporting functions colorjam::group2colors(), colorjam::blend_colors(), nudge_sp().

Details

This function takes a named list of polygons and returns the combination of polygon overlaps as used in a Venn diagram.

When a vector of Venn counts is supplied, the counts are associated with the respective polygon, and any counts not represented by a polygon are returned as an attribute "venn_missing".

Value

JamPolygon object, which contains columns:

• "name"

• "x", "y"

• "fill"

• "venn_name"

• "venn_count"

• "venn_items"

• "venn_color"

• "label"

• "label_x"

• "label_y"

See Also

Other JamPolygon: JamPolygon-class, Venndir-class, [,JamPolygon,ANY,ANY,ANY-method, add_orientation_JamPolygon(), area_JamPolygon(), bbox_JamPolygon(), buffer_JamPolygon(), check_JamPolygon(), check_Venndir(), eulerr_to_JamPolygon(), farthest_point_JamPolygon(), has_point_in_JamPolygon(), intersect_JamPolygon(), label_fill_JamPolygon(), label_outside_JamPolygon(), label_segment_JamPolygon(), labelr_JamPolygon(), minus_JamPolygon(), nearest_point_JamPolygon(), nudge_JamPolygon(), plot.JamPolygon(), point_in_JamPolygon(), polyclip_to_JamPolygon(), polygon_circles(), polygon_ellipses(), sample_JamPolygon(), split_JamPolygon(), union_JamPolygon(), update_JamPolygon()

Examples

# simple Venn circles
test_counts <- c(A=5, B=10, C=3, `B&C`=2)
x <- eulerr::euler(test_counts)
jp1 <- eulerr_to_JamPolygon(x)
polygon_colors <- colorjam::rainbowJam(length(jp1))
jp1@polygons$fill <- polygon_colors;
plot(jp1)

xo <- find_venn_overlaps_JamPolygon(jp=jp1, venn_counts=test_counts)
xo@polygons$outerborder <- jamba::makeColorDarker(darkFactor=1.2,
   xo@polygons$venn_color)
xo@polygons$outerborder.lwd <- 4;
plot(xo);

jmw86069/venndir documentation built on Nov. 14, 2024, 10:12 a.m.