blockArrowMargin: Draw block arrows in plot margins

In jmw86069/jamma: MA-plots for omics data

Draw block arrows in plot margins

Description

Draw block arrows in plot margins

Usage

blockArrowMargin(
  axisPosition = "rightAxis",
  arrowPosition = "top",
  arrowLabel = "",
  arrowDirection = "updown",
  xleft = NULL,
  xright = NULL,
  ybottom = NULL,
  ytop = NULL,
  col = "#660000FF",
  labelFont = 1,
  labelCex = 1,
  border = "#000000FF",
  xpd = TRUE,
  parUsr = par("usr"),
  arrowWidthPercent = 6,
  blockWidthPercent = 5,
  arrowLengthPercent = blockWidthPercent * 0.6,
  bufferPercent = 0.5,
  blankFirst = FALSE,
  arrowLabelColor = NULL,
  arrowLabelBorder = "#000000FF",
  doExample = FALSE,
  doBlockGradient = TRUE,
  doShadowText = TRUE,
  gradientDarkFactor = 1.5,
  gradientSFactor = 1.5,
  verbose = FALSE,
  ...
)

Details

This function draws block arrows in plot margins, intended to be used to describe plot axis ranges with an optional label. The driving example is to describe the number of statistical hits shown on a volcano plot.

Run blockArrowMargin(doExample=TRUE) to see a visual example.

See Also

Other jam utility functions: find_colname(), fold_to_log2fold(), get_se_assaydata(), gradient_rect(), handle_highlightPoints(), log2fold_to_fold(), logAxis(), outer_legend(), points2polygonHull(), update_function_params(), update_list_elements()

Examples

blockArrowMargin(doExample=TRUE)

jmw86069/jamma documentation built on Oct. 11, 2024, 7:08 a.m.