Diff of /man/getSilhouette.Rd [000000] .. [494cbf]

Switch to unified view

a b/man/getSilhouette.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/getSilhouette.R
3
\name{getSilhouette}
4
\alias{getSilhouette}
5
\title{Get silhoutte plot from consensus clustering}
6
\usage{
7
getSilhouette(
8
  sil = NULL,
9
  clust.col = c("#2EC4B6", "#E71D36", "#FF9F1C", "#BDD5EA", "#FFA5AB", "#011627",
10
    "#023E8A", "#9D4EDD"),
11
  fig.path = getwd(),
12
  fig.name = "silhoutte",
13
  width = 5.5,
14
  height = 5
15
)
16
}
17
\arguments{
18
\item{sil}{A sil object returned from `getConsensusMOIC()`.}
19
20
\item{clust.col}{A string vector storing colors for annotating each cluster.}
21
22
\item{fig.path}{A string value to indicate the output path for storing the consensus heatmap.}
23
24
\item{fig.name}{A string value to indicate the name of the consensus heatmap.}
25
26
\item{width}{A numeric value to indicate the width of output figure.}
27
28
\item{height}{A numeric value to indicate the height of output figure.}
29
}
30
\value{
31
A silhoutte barplot.
32
}
33
\description{
34
This function visualizes the silhoutte information.
35
}
36
\examples{
37
# There is no example and please refer to vignette.
38
}