PomaHeatmap: Heatmap Plot
In pcastellanoescuder/POMA_package: Tools for Omics Data Analysis

PomaHeatmap

R Documentation

Heatmap Plot

Description

PomaHeatmap generates a heatmap.

Usage

PomaHeatmap(
  data,
  covs = NULL,
  sample_names = TRUE,
  feature_names = FALSE,
  show_legend = TRUE
)

Arguments

`data`	A `SummarizedExperiment` object.
`covs`	Character vector. Indicates the names of `colData` columns to be included as covariates. Default is NULL (no covariates).
`sample_names`	Logical. Indicates if sample names should be displayed or not. Default is TRUE.
`feature_names`	Logical. Indicates if feature names should be displayed or not. Default is FALSE.
`show_legend`	Logical. Indicates if legend should be displayed or not. Default is TRUE.

Value

A heatmap plot.

Author(s)

Pol Castellano-Escuder

Examples

data <- POMA::st000284 %>% # Example SummarizedExperiment object included in POMA
  PomaNorm()

# Basic heatmap
data %>% 
  PomaHeatmap()

# Heatmap with one covariate  
data %>% 
  PomaHeatmap(covs = "factors")

# Heatmap with two covariates
data %>% 
  PomaHeatmap(covs = c("factors", "smoking_condition"))

pcastellanoescuder/POMA_package documentation built on Nov. 18, 2024, 10:43 p.m.