anno_boxplot {ComplexHeatmap} | R Documentation

## Using boxplot as annotation

### Description

Using boxplot as annotation

### Usage

    anno_boxplot(x, which = c("column", "row"), border = TRUE,
        gp = gpar(fill = "#CCCCCC"), ylim = NULL, outline = TRUE,
        pch = 16, size = unit(2, "mm"), axis = FALSE, axis_side = NULL,
        axis_gp = gpar(fontsize = 8), axis_direction = c("normal", "reverse"))

### Arguments

`x` | a matrix or a list. If `x` is a matrix and if `which` is `column`, statistics for boxplot is calculated by columns, if `which` is `row`, the calculation is by rows.
`which` | is the annotation a column annotation or a row annotation?
`border` | whether show border of the annotation compoment
`gp` | graphic parameters
`ylim` | data ranges.
`outline` | whether draw outliers
`pch` | point type
`size` | point size
`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?

### Value

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

### Author(s)

Zuguang Gu <z.gu@dkfz.de>

### Examples

    mat = matrix(rnorm(32), nrow = 4)
    f = anno_boxplot(mat)
    grid.newpage(); f(1:8)

    f = anno_boxplot(mat, which = "row")
    grid.newpage(); f(1:4)

    lt = lapply(1:4, function(i) rnorm(8))
    f = anno_boxplot(lt)
    grid.newpage(); f(1:4)

[Package ComplexHeatmap version 1.20.0 Index]