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

Switch to unified view

a b/man/getLRAcluster.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/getLRAcluster.R
3
\name{getLRAcluster}
4
\alias{getLRAcluster}
5
\title{Get subtypes from LRAcluster}
6
\usage{
7
getLRAcluster(
8
  data = NULL,
9
  N.clust = NULL,
10
  type = rep("gaussian", length(data)),
11
  clusterAlg = "ward.D"
12
)
13
}
14
\arguments{
15
\item{data}{List of matrices.}
16
17
\item{N.clust}{Number of clusters.}
18
19
\item{type}{Data type corresponding to the list of matrics, which can be gaussian, binomial or possion; 'gaussian' by default.}
20
21
\item{clusterAlg}{A string value to indicate the cluster algorithm for similarity matrix; 'ward.D' by default.}
22
}
23
\value{
24
A list with the following components:
25
26
        \code{fit}        an object returned by \link[LRAcluster]{LRAcluster}.
27
28
        \code{clust.res}  a data.frame storing sample ID and corresponding clusters.
29
30
        \code{clust.dend} a dendrogram of sample clustering.
31
32
        \code{mo.method}  a string value indicating the method used for multi-omics integrative clustering.
33
}
34
\description{
35
This function wraps the LRAcluster (Integrated cancer omics data anlsysi by low rank approximation) algorithm and provides standard output for `getMoHeatmap()` and `getConsensusMOIC()`.
36
}
37
\examples{
38
# There is no example and please refer to vignette.
39
}
40
\references{
41
Wu D, Wang D, Zhang MQ, Gu J (2015). Fast dimension reduction and integrative clustering of multi-omics data using low-rank approximation: application to cancer molecular classification. BMC Genomics, 16(1):1022.
42
}