Diff of /man/getSNF.Rd [000000] .. [494cbf]

Switch to unified view

a b/man/getSNF.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/getSNF.R
3
\name{getSNF}
4
\alias{getSNF}
5
\title{Get subtypes from SNF}
6
\usage{
7
getSNF(
8
  data = NULL,
9
  N.clust = NULL,
10
  type = rep("gaussian", length(data)),
11
  K = 30,
12
  t = 20,
13
  sigma = 0.5
14
)
15
}
16
\arguments{
17
\item{data}{List of matrices.}
18
19
\item{N.clust}{Number of clusters.}
20
21
\item{type}{Data type corresponding to the list of matrics, which can be gaussian, binomial or possion.}
22
23
\item{K}{An integer value to indicate the number of neighbors in K-nearest neighbors part of the algorithm.}
24
25
\item{t}{An integer value to indicate the number of interations for the diffusion process.}
26
27
\item{sigma}{A numerical value to indicate the variance for local model.}
28
}
29
\value{
30
A list with the following components:
31
32
        \code{fit}       an object returned by \link[SNFtool]{SNF}.
33
34
        \code{clust.res} a data.frame storing sample ID and corresponding clusters.
35
36
        \code{mo.method} a string value indicating the method used for multi-omics integrative clustering.
37
}
38
\description{
39
This function wraps the SNF (Similarity Network Fusion) algorithm and provides standard output for `getMoHeatmap()` and `getConsensusMOIC()`.
40
}
41
\examples{
42
# There is no example and please refer to vignette.
43
}
44
\references{
45
Wang B, Mezlini AM, Demir F, et al (2014). Similarity network fusion for aggregating data types on a genomic scale. Nat Methods, 11(3):333-337.
46
}