set_annot_genes: Set Gene Annotations to Appear Along Left Side of Heatmaps

View source: R/params_functions.R View source: R/Package-Code5-Compiled.R

set_annot_genesR Documentation

Set Gene Annotations to Appear Along Left Side of Heatmaps

Description

Specify which gene annotations should appear along the left side of heatmaps

Usage

set_annot_genes(annotations = NULL)

Arguments

annotations

a character vector including the column names in the annotations.genes parameter (set_annotations.genes) that should be shown as annotations in the heatmap. If no argument is supplied, assumes that all columns in the annotations.genes parameter should be shown in the heatmap. For showing multiple annotations, the order in which the annotations are listed is the order they will appear on the heatmap from the closest to the heatmap on the right to those farthest on the left. To remove all annotation tracks and reset, simply set to NA.

Details

Draws from the annotations.genes parameter stored in the params list object to hold only the annotations that should be shown in heatmaps. See set_annotations.genes, must be run prior to this function.

To specify the colors that will accompany each level of each annotation, see set_annot_cols. If colors are not specified, default color values will be applied when necessary. (Not all annotations need to have custom colors, those that do not will be given default colors while those that are specified will be shown as such.)

Author(s)

~~Alison Moss~~

See Also

See set_annotations.genes and set_annot_cols Works the same as for sample annotations, see set_annot_samps for examples


axm323/dataVisEasy documentation built on Feb. 1, 2024, 11:53 p.m.