|
a |
|
b/man/comptSNE.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/DIscBIO-generic-comptSNE.R |
|
|
3 |
\name{comptSNE} |
|
|
4 |
\alias{comptSNE} |
|
|
5 |
\alias{comptSNE,DISCBIO-method} |
|
|
6 |
\title{Computing tSNE} |
|
|
7 |
\usage{ |
|
|
8 |
comptSNE( |
|
|
9 |
object, |
|
|
10 |
rseed = NULL, |
|
|
11 |
max_iter = 5000, |
|
|
12 |
epoch = 500, |
|
|
13 |
quiet = FALSE, |
|
|
14 |
... |
|
|
15 |
) |
|
|
16 |
|
|
|
17 |
\S4method{comptSNE}{DISCBIO}( |
|
|
18 |
object, |
|
|
19 |
rseed = NULL, |
|
|
20 |
max_iter = 5000, |
|
|
21 |
epoch = 500, |
|
|
22 |
quiet = FALSE, |
|
|
23 |
... |
|
|
24 |
) |
|
|
25 |
} |
|
|
26 |
\arguments{ |
|
|
27 |
\item{object}{\code{DISCBIO} class object.} |
|
|
28 |
|
|
|
29 |
\item{rseed}{Random integer to to yield reproducible maps across different |
|
|
30 |
runs} |
|
|
31 |
|
|
|
32 |
\item{max_iter}{maximum number of iterations to perform.} |
|
|
33 |
|
|
|
34 |
\item{epoch}{The number of iterations in between update messages.} |
|
|
35 |
|
|
|
36 |
\item{quiet}{if `TRUE`, suppresses intermediate output} |
|
|
37 |
|
|
|
38 |
\item{...}{other parameters to be passed to `tsne::tsne`} |
|
|
39 |
} |
|
|
40 |
\value{ |
|
|
41 |
The DISCBIO-class object input with the tsne slot filled. |
|
|
42 |
} |
|
|
43 |
\description{ |
|
|
44 |
This function is used to compute the t-Distributed Stochastic |
|
|
45 |
Neighbor Embedding (t-SNE). |
|
|
46 |
} |
|
|
47 |
\examples{ |
|
|
48 |
sc <- DISCBIO(valuesG1msTest) # changes signature of data |
|
|
49 |
sc <- Clustexp(sc, cln = 2) # data must be clustered before plottin |
|
|
50 |
sc <- comptSNE(sc, max_iter = 30) |
|
|
51 |
head(sc@tsne) |
|
|
52 |
|
|
|
53 |
} |