Draw an arrow — ccArrow • circlizePlus

Object ccCellGeom will call the function circlize::circos.arrow while drawing.

Usage

ccArrow(
  x1,
  x2,
  y = get.cell.meta.data("ycenter"),
  width = get.cell.meta.data("yrange")/2,
  arrow.head.length = mm_x(5),
  arrow.head.width = width * 2,
  arrow.position = c("end", "start"),
  tail = c("normal", "point"),
  border = "black",
  col = "#FFCCCC",
  lty = par("lty"),
  ...
)

Arguments

x1: Start position of the arrow on the x-axis.
x2: End position of the arrow on the x-axis. Note x2 should be larger than x1. The direction of arrows can be controlled by arrow.position argument.
y: Position of the arrow on the y-axis. Note this is the center of the arrow on y-axis.
width: Width of the arrow body.
arrow.head.length: Length of the arrow head. Note the value should be smaller than the length of the arrow itself (which is x2 - x1).
arrow.head.width: Width of the arrow head.
arrow.position: Where is the arrow head on the arrow. If you want to the arrow in the reversed direction, set this value to "start".
tail: The shape of the arrow tail (the opposite side of arrow head).
border: Border color of the arrow.
col: Filled color of the arrow.
lty: Line style of the arrow.
...: Pass to polygon.

Value

Object ccCellGeom

Examples

library(circlizePlus)
cc <- ccPlot(sectors = letters[1:4], xlim = c(0, 10))
track <- ccTrack(ylim = c(0, 1))
cell <- ccCell(sector.index = "a") + ccArrow(x1 = 1, x2 = 9)
#> Error: It seems the circular plot has not been initialized.
track <- track + cell
#> Error: object 'cell' not found
cc + track