anno_barplot: Using barplot as annotation

Description Usage Arguments Value Author(s) Examples

View source: R/annotation_fun.R

Description

Using barplot as annotation

Usage

1
2
3
anno_barplot(x, baseline = "min", which = c("column", "row"), border = TRUE, bar_width = 0.6,
    gp = gpar(fill = "#CCCCCC"), ylim = NULL, axis = FALSE, axis_side = NULL,
    axis_gp = gpar(fontsize = 8), axis_direction = c("normal", "reverse"), ...)

Arguments

x

a vector of numeric values. If the value is a matrix, columns of the matrix will be represented as stacked barplots. Note for stacked barplots, each row in the matrix should only contain values with same sign (either all positive or all negative).

baseline

baseline for bars. The value should be "min" or "max", or a numeric value. It is enforced to be zero for stacked barplots.

which

is the annotation a column annotation or a row annotation?

border

whether show border of the annotation compoment

bar_width

relative width of the bars, should less than one

gp

graphic parameters. If it is the stacked barplots, the length of the graphic parameter should be same as the number of stacks.

ylim

data ranges.

axis

whether add axis

axis_side

if it is placed as column annotation, value can only be "left" or "right". If it is placed as row annotation, value can only be "bottom" or "top".

axis_gp

graphic parameters for axis

axis_direction

if the annotation is row annotation, should the axis be from left to right (default) or follow the reversed direction?

...

for future use.

Value

A graphic function which can be set in HeatmapAnnotation constructor method.

Author(s)

Zuguang Gu <[email protected]>

Examples

1
2
3
4
5
f = anno_barplot(rnorm(10))
grid.newpage(); f(1:10)

f = anno_barplot(rnorm(10), which = "row")
grid.newpage(); f(1:10)

eilslabs/ComplexHeatmap documentation built on Oct. 19, 2017, 2:13 p.m.