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

Switch to unified view

a b/man/getCIMLR.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/getCIMLR.R
3
\name{getCIMLR}
4
\alias{getCIMLR}
5
\title{Get subtypes from CIMLR}
6
\usage{
7
getCIMLR(
8
  data = NULL,
9
  N.clust = NULL,
10
  type = rep("gaussian", length(data)),
11
  cores.ratio = 0,
12
  verbose = TRUE
13
)
14
}
15
\arguments{
16
\item{data}{List of matrices.}
17
18
\item{N.clust}{Number of clusters.}
19
20
\item{type}{Data type corresponding to the list of matrics, which can be gaussian, binomial or possion.}
21
22
\item{cores.ratio}{Ratio of the number of cores to be used when computing the multi-kernel.}
23
24
\item{verbose}{A logic value to indicate if supressing progression.}
25
}
26
\value{
27
A list with the following components:
28
29
        \code{fit}       an object returned by \link[CIMLR]{CIMLR}.
30
31
        \code{clust.res} a data.frame storing sample ID and corresponding clusters.
32
33
        \code{feat.res}  the results of features selection process.
34
35
        \code{mo.method} a string value indicating the method used for multi-omics integrative clustering.
36
}
37
\description{
38
This function wraps the CIMLR (Cancer Integration via Multikernel Learning) algorithm and provides standard output for `getMoHeatmap()` and `getConsensusMOIC()`.
39
}
40
\examples{
41
# There is no example and please refer to vignette.
42
}
43
\references{
44
Ramazzotti D, Lal A, Wang B, Batzoglou S, Sidow A (2018). Multi-omic tumor data reveal diversity of molecular mechanisms that correlate with survival. Nat Commun, 9(1):4453.
45
}