Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
multimodalR/man/useMclust.Rd
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
45 lines (40 sloc)
1.52 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
% Generated by roxygen2: do not edit by hand | |
% Please edit documentation in R/algorithmSpecificFunctions.R | |
\name{useMclust} | |
\alias{useMclust} | |
\title{UseMclust} | |
\usage{ | |
useMclust(expression, clusterNumbers = NULL, verbose = TRUE, | |
parallel = FALSE, pathToClinicalData = "pathTo/clinicalData", | |
pathToExpressionmatrix = "pathTo/expressionmatrix") | |
} | |
\arguments{ | |
\item{expression}{(Simulated) Gene Expression data frame which genes shall | |
be classified as unimodal, bimodal or other} | |
\item{clusterNumbers}{span of the clusters to be calculated at maximum} | |
\item{verbose}{logical. Whether to print progress messages} | |
\item{parallel}{logical. Whether to calculate the mclust models in parallel} | |
\item{pathToClinicalData}{If real data is used the path | |
to the clinical data can be stored here} | |
\item{pathToExpressionmatrix}{If real data is used the path | |
to the gene expression matrix can be stored here} | |
} | |
\value{ | |
The formatted output of the mclust algorithm | |
} | |
\description{ | |
Use the mclust algorithm for generating output to evaluate the | |
classification (unimodal,bimodal or other) of genes. | |
} | |
\examples{ | |
\dontrun{ | |
params <- newParams(nGenes = list("1"=10,"2"=list("gauss"= 10,"gamma"= 10))) | |
simulation <- simulateExpression(params= params,verbose=FALSE) | |
expression <- simulation$expressionData | |
#with messages printed to console | |
mclustOutput <- useMclust(expression = expression) | |
#without messages printed to console, at maximum 3 clusters | |
mclustOutput <- useMclust(expression = expression, clusterNumbers = c(1:3), | |
verbose = FALSE, parallel = FALSE) | |
} | |
} |