varAnnotation: Helper to specify a HeatmapAnnotation for variables in...

In david-barnett/microViz: Microbiome Data Analysis and Visualization

Helper to specify a HeatmapAnnotation for variables in cor_heatmap

Description

Helper to specify a HeatmapAnnotation for variables in cor_heatmap

Usage

varAnnotation(
  ...,
  name,
  annotation_legend_param = list(),
  show_legend = TRUE,
  gp = grid::gpar(col = NA),
  border = FALSE,
  gap = grid::unit(2, "mm"),
  show_annotation_name = TRUE,
  annotation_label = NULL,
  annotation_name_gp = grid::gpar(),
  annotation_name_offset = NULL,
  annotation_name_rot = NULL,
  annotation_name_align = FALSE,
  annotation_name_side = "auto",
  .data = NULL,
  .vars = NULL,
  .side = NULL
)

Arguments

...	Name-value pairs where the names correspond to annotation names and values are the output of variable annotation functions such as anno_var_box(), or manually specified AnnotationFunction objects
name	Name of the heatmap annotation, optional.
annotation_legend_param	A list which contains parameters for annotation legends. See color_mapping_legend,ColorMapping-method for all possible options.
show_legend	Whether show annotation legends. The value can be one single value or a vector.
gp	Graphic parameters for simple annotations (with fill parameter ignored).
border	border of single annotations.
gap	Gap between annotations. It can be a single value or a vector of unit objects.
show_annotation_name	Whether show annotation names? For column annotation, annotation names are drawn either on the left or the right, and for row annotations, names are draw either on top or at the bottom. The value can be a vector.
annotation_label	Labels for the annotations. By default it is the same as individual annotation names.
annotation_name_gp	Graphic parameters for annotation names. Graphic parameters can be vectors.
annotation_name_offset	Offset to the annotation names, a unit object. The value can be a vector.
annotation_name_rot	Rotation of the annotation names. The value can be a vector.
annotation_name_align	Whether to align the annotation names.
annotation_name_side	Side of the annotation names.
.data	OPTIONAL phyloseq or psExtra, only set this to override use of same data as in heatmap
.vars	OPTIONAL selection vector of variables (names, numbers or logical), only set this if providing .data argument to override default
.side	OPTIONAL string, indicating the side for the variable annotations: only set this to override default

Value

HeatmapAnnotation object

See Also

taxAnnotation()

david-barnett/microViz documentation built on April 17, 2025, 4:25 a.m.