plot_sample_suprahex: Suprahex plots

View source: R/suprahex_plots.R

plot_sample_suprahexR Documentation

Suprahex plots

Description

Plots supraHex plots of each sample using functions from the supraHex package. See the supraHex paper and package vignette for more information.

Usage

plot_sample_suprahex(
  object,
  all_features = FALSE,
  sample_labels = "Sample_ID",
  grid_xdim = NULL,
  grid_ydim = NULL,
  title.xy = c(0.35, 1),
  title.rotate = 0,
  fontsize = 10,
  colormap = "jet",
  ...
)

Arguments

object

a MetaboSet object

all_features

if FALSE, flagged features are droppped

sample_labels

the column for labels of samples in the plot

grid_xdim, grid_ydim

dimensions of the grid for the samples

title.xy

position of the sample label relative to the supraHex

title.rotate

rotation of the sample label in degrees

fontsize

the fontsize for sample labels

colormap

colormap for the hexagons

...

other parameters for supraHex::sPipeline

See Also

sPipeline, sCompReorder, visCompReorder

Examples

## Not run: 
plot_sample_suprahex(merged_sample[, 1:20],
  xdim = 5, title.xy = c(0.35, 1),
  grid_xdim = 7, grid_ydim = 7, sample_labels = "Group"
)

## End(Not run)

antonvsdata/notame documentation built on Sept. 14, 2024, 11:09 p.m.