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

Switch to unified view

a b/man/ClustDiffGenes.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/DIscBIO-generic-ClustDiffGenes.R
3
\name{ClustDiffGenes}
4
\alias{ClustDiffGenes}
5
\alias{ClustDiffGenes,DISCBIO-method}
6
\title{ClustDiffGenes}
7
\usage{
8
ClustDiffGenes(
9
  object,
10
  K,
11
  pValue = 0.05,
12
  fdr = 0.01,
13
  export = FALSE,
14
  quiet = FALSE,
15
  filename_up = "Up-DEG-cluster",
16
  filename_down = "Down-DEG-cluster",
17
  filename_binom = "binomial-DEGsTable",
18
  filename_sigdeg = "binomial-sigDEG"
19
)
20
21
\S4method{ClustDiffGenes}{DISCBIO}(
22
  object,
23
  K,
24
  pValue = 0.05,
25
  fdr = 0.01,
26
  export = FALSE,
27
  quiet = FALSE,
28
  filename_up = "Up-DEG-cluster",
29
  filename_down = "Down-DEG-cluster",
30
  filename_binom = "binomial-DEGsTable",
31
  filename_sigdeg = "binomial-sigDEG"
32
)
33
}
34
\arguments{
35
\item{object}{\code{DISCBIO} class object.}
36
37
\item{K}{A numeric value of the number of clusters.}
38
39
\item{pValue}{A numeric value of the p-value. Default is 0.05.}
40
41
\item{fdr}{A numeric value of the false discovery rate. Default is 0.01.}
42
43
\item{export}{A logical vector that allows writing the final gene list in
44
excel file. Default is TRUE.}
45
46
\item{quiet}{if `TRUE`, suppresses intermediate text output}
47
48
\item{filename_up}{Name of the exported "up" file (if `export=TRUE`)}
49
50
\item{filename_down}{Name of the exported "down" file (if `export=TRUE`)}
51
52
\item{filename_binom}{Name of the exported binomial file}
53
54
\item{filename_sigdeg}{Name of the exported sigDEG file}
55
}
56
\value{
57
A list containing two tables.
58
}
59
\description{
60
Creates a table of cluster differences
61
}
62
\examples{
63
sc <- DISCBIO(valuesG1msTest)
64
sc <- Clustexp(sc, cln = 3, quiet = TRUE)
65
cdiff <- ClustDiffGenes(sc, K = 3, fdr = .3, export = FALSE)
66
str(cdiff)
67
cdiff[[2]]
68
}