1 | 1 |
deleted file mode 100644 |
... | ... |
@@ -1,46 +0,0 @@ |
1 |
-% plot silhouette |
|
2 |
-\name{SGC_plot_silhouette} |
|
3 |
-\alias{SGC_plot_silhouette} |
|
4 |
-\title{Plots Gene Silhouette Index In SGC Pipeline} |
|
5 |
-\description{ |
|
6 |
- Plots the Silhouette index of genes in SGC pipeline. |
|
7 |
-} |
|
8 |
-\usage{ |
|
9 |
- SGC_plot_silhouette(df, tit = "Gene Silhouette Index", |
|
10 |
- xname = "genes", yname = "silhouette index") |
|
11 |
-} |
|
12 |
-\arguments{ |
|
13 |
- \item{df}{the silhouette dataframe returned by clustering function in SGC pipeline} |
|
14 |
- \item{tit}{plot title, default "Gene Silhouette Index"} |
|
15 |
- \item{xname}{x-axis title, default "genes"} |
|
16 |
- \item{yname}{y-axis title, default "silhouette index"} |
|
17 |
-} |
|
18 |
- |
|
19 |
-\details{ |
|
20 |
-In order to plot silhouette index, `sil` parameter in clustering function must be set to TRUE. |
|
21 |
-} |
|
22 |
- |
|
23 |
- |
|
24 |
-\value{ |
|
25 |
- returns the plot, an object of ggplot class. |
|
26 |
-} |
|
27 |
- |
|
28 |
- |
|
29 |
- |
|
30 |
-\references{ |
|
31 |
- \href{https://arxiv.org/abs/2209.10545}{Aghaieabiane, N and Koutis, I (2022) SGC: A semi-supervised pipeline for gene clustering using self-training approach in gene co-expression networks} |
|
32 |
-} |
|
33 |
- |
|
34 |
-\seealso{ |
|
35 |
- \code{\link{clustering}} |
|
36 |
- \code{\link{SGC_ezPLOT}} |
|
37 |
- \href{https://github.com/na396/SGC}{SGC Toturial} |
|
38 |
-} |
|
39 |
-\examples{ |
|
40 |
- |
|
41 |
-## let silhouetteDF be the silhouette field in output of clustering function |
|
42 |
-# to plot the conductance value |
|
43 |
-pl = SGC_plot_silhouette(df = silhouetteDF) |
|
44 |
- |
|
45 |
-} |
|
46 |
- |