Diff of /man/DEGanalysis.Rd [000000] .. [28e211]

Switch to unified view

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