Skip to contents

Draws a simple two-set Venn diagram for significant features in two signatures retrieved from the SigRepo database.

Usage

plotSignatureOverlap(
  conn_handler = NULL,
  signature_id_a = NULL,
  signature_name_a = NULL,
  signature_id_b = NULL,
  signature_name_b = NULL,
  omic_signature_a = NULL,
  omic_signature_b = NULL,
  feature_col = "feature_name",
  label_a = NULL,
  label_b = NULL,
  fill = c("#3B82F6", "#F97316"),
  alpha = 0.35,
  main = "Significant feature overlap",
  short_label_a = "S1",
  short_label_b = "S2",
  verbose = TRUE
)

Arguments

conn_handler

An R object obtained from SigRepo::newConnHandler(). Required unless omic_signature_a and omic_signature_b are supplied.

signature_id_a

Database ID for signature A.

signature_name_a

Name for signature A.

signature_id_b

Database ID for signature B.

signature_name_b

Name for signature B.

omic_signature_a

Optional OmicSignature R6 object for signature A.

omic_signature_b

Optional OmicSignature R6 object for signature B.

feature_col

Column containing feature names. Defaults to "feature_name".

label_a

Label for signature A.

label_b

Label for signature B.

fill

Fill colors for the two circles.

alpha

Transparency value between 0 and 1.

main

Plot title.

short_label_a

Short label shown for signature A in the Venn diagram. Defaults to "S1".

short_label_b

Short label shown for signature B in the Venn diagram. Defaults to "S2".

verbose

Logical; whether or not to print diagnostic messages while retrieving signatures. Defaults to TRUE.

Value

Invisibly returns the overlap count table from compareSignatureFeatures().