upset_top_annotation: Default UpSet Top Annotation

View source: R/Upset.R

upset_top_annotationR Documentation

Default UpSet Top Annotation

Description

Default UpSet Top Annotation

Usage

upset_top_annotation(m,
    gp = gpar(fill = "black"),
    height = unit(ifelse(set_on_rows, 3, 2), "cm"),
    show_annotation_name = TRUE,
    annotation_name_gp = gpar(),
    annotation_name_offset = NULL,
    annotation_name_side = "left",
    annotation_name_rot = 0,
    ...)

Arguments

m

A combination matrix which is as same as the one for UpSet.

gp

Graphic parameters for bars.

height

The height of the top annotation.

show_annotation_name

Whether show annotation names?

annotation_name_gp

Graphic parameters for anntation names.

annotation_name_offset

Offset to the annotation name, a unit object.

annotation_name_side

Side of the annotation name.

annotation_name_rot

Rotation of the annotation name, it can only take values in c(00, 90, 180, 270).

...

Passed to anno_barplot.

Details

The default top annotation is actually barplot implemented by anno_barplot. For how to set the top annotation or bottom annotation in UpSet, please refer to UpSet.

If you want to use decorate_annotation function, the annotation name for the "sets" is set_size and the annotation name for the "intersection sets" are intersection_size and if under the union mode, it is union_size.

Examples

# There is no example
NULL


jokergoo/ComplexHeatmap documentation built on Sept. 24, 2024, 4:48 p.m.