PlotKmeans: Plot K-means analysis

View source: R/stats_clustering.R

PlotKmeansR Documentation

Plot K-means analysis

Description

Plot K-means analysis

Usage

PlotKmeans(
  mSetObj = NA,
  imgName,
  format = "png",
  dpi = 72,
  width = NA,
  colpal = "default",
  facet = FALSE
)

Arguments

mSetObj

Input name of the created mSet Object

imgName

Input a name for the plot

format

Select the image format, "png", or "pdf".

dpi

Input the dpi. If the image format is "pdf", users need not define the dpi. For "png" images, the default dpi is 72. It is suggested that for high-resolution images, select a dpi of 300.

width

Input the width, there are 2 default widths, the first, width = NULL, is 10.5. The second default is width = 0, where the width is 7.2. Otherwise users can input their own width.

colpal

Character, input "default" to use the default ggplot color scheme or "colblind" to use the color-blind friendly palette.

facet

logical, TRUE to plot in multiple facets

Author(s)

Jeff Xiajeff.xia@mcgill.ca McGill University, Canada License: GNU GPL (>= 2)


xia-lab/MetaboAnalystR documentation built on April 20, 2024, 8:13 p.m.