|
a |
|
b/man/DEGanalysis2clust.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/DIscBIO-generic-DEGanalysis2clust.R |
|
|
3 |
\name{DEGanalysis2clust} |
|
|
4 |
\alias{DEGanalysis2clust} |
|
|
5 |
\alias{DEGanalysis2clust,DISCBIO-method} |
|
|
6 |
\title{Determining differentially expressed genes (DEGs) between two |
|
|
7 |
particular clusters.} |
|
|
8 |
\usage{ |
|
|
9 |
DEGanalysis2clust( |
|
|
10 |
object, |
|
|
11 |
K, |
|
|
12 |
Clustering = "K-means", |
|
|
13 |
fdr = 0.05, |
|
|
14 |
name = "Name", |
|
|
15 |
First = "CL1", |
|
|
16 |
Second = "CL2", |
|
|
17 |
export = FALSE, |
|
|
18 |
quiet = FALSE, |
|
|
19 |
plot = TRUE, |
|
|
20 |
filename_deg = "DEGsTable", |
|
|
21 |
filename_sigdeg = "sigDEG", |
|
|
22 |
... |
|
|
23 |
) |
|
|
24 |
|
|
|
25 |
\S4method{DEGanalysis2clust}{DISCBIO}( |
|
|
26 |
object, |
|
|
27 |
K, |
|
|
28 |
Clustering = "K-means", |
|
|
29 |
fdr = 0.05, |
|
|
30 |
name = "Name", |
|
|
31 |
First = "CL1", |
|
|
32 |
Second = "CL2", |
|
|
33 |
export = FALSE, |
|
|
34 |
quiet = FALSE, |
|
|
35 |
plot = TRUE, |
|
|
36 |
filename_deg = "DEGsTable", |
|
|
37 |
filename_sigdeg = "sigDEG", |
|
|
38 |
... |
|
|
39 |
) |
|
|
40 |
} |
|
|
41 |
\arguments{ |
|
|
42 |
\item{object}{\code{DISCBIO} class object.} |
|
|
43 |
|
|
|
44 |
\item{K}{A numeric value of the number of clusters.} |
|
|
45 |
|
|
|
46 |
\item{Clustering}{Clustering has to be one of the following: |
|
|
47 |
["K-means","MB"]. Default is "K-means"} |
|
|
48 |
|
|
|
49 |
\item{fdr}{A numeric value of the false discovery rate. Default is 0.05.} |
|
|
50 |
|
|
|
51 |
\item{name}{A string vector showing the name to be used to save the resulted |
|
|
52 |
tables.} |
|
|
53 |
|
|
|
54 |
\item{First}{A string vector showing the first target cluster. Default is |
|
|
55 |
"CL1"} |
|
|
56 |
|
|
|
57 |
\item{Second}{A string vector showing the second target cluster. Default is |
|
|
58 |
"CL2"} |
|
|
59 |
|
|
|
60 |
\item{export}{A logical vector that allows writing the final gene list in |
|
|
61 |
excel file. Default is TRUE.} |
|
|
62 |
|
|
|
63 |
\item{quiet}{if `TRUE`, suppresses intermediate text output} |
|
|
64 |
|
|
|
65 |
\item{plot}{if `TRUE`, plots are generated} |
|
|
66 |
|
|
|
67 |
\item{filename_deg}{Name of the exported DEG table} |
|
|
68 |
|
|
|
69 |
\item{filename_sigdeg}{Name of the exported sigDEG table} |
|
|
70 |
|
|
|
71 |
\item{...}{additional parameters to be passed to samr()} |
|
|
72 |
} |
|
|
73 |
\value{ |
|
|
74 |
A list containing two tables. |
|
|
75 |
} |
|
|
76 |
\description{ |
|
|
77 |
This function defines DEGs between particular clusters generated |
|
|
78 |
by either K-means or model based clustering. |
|
|
79 |
} |