getCluster: Get variable cluster from (s)PCA, (s)PLS or block.(s)PLS

Description Usage Arguments Details Value See Also Examples

View source: R/getCluster.R

Description

This function returns the cluster associated to each feature from a mixOmics object.

Usage

1
getCluster(X, user.block = NULL, user.cluster = NULL)

Arguments

X

an object of the class: pca, spca, pls, spls, block.pls or block.spls

user.block

a vector to filter the result and return the features of the specified blocks.

user.cluster

a vector to filter the result and return only the features of the specified clusters

Details

For each feature, the cluster is assigned according to the maximum contribution on a component and the sign of that contribution.

Value

A data.frame containing the name of feature, its assigned cluster and other information such as selected component, contribution, sign, ...

See Also

selectVar

Examples

1
2
3
4
5
6
7
demo <- suppressWarnings(get_demo_cluster())
pca.cluster <- getCluster(demo$pca)
spca.cluster <- getCluster(demo$spca)
pls.cluster <- getCluster(demo$pls)
spls.cluster <- getCluster(demo$spls)
block.pls.cluster <- getCluster(demo$block.pls)
block.spls.cluster <- getCluster(demo$block.spls)

abodein/timeOmics_BioC documentation built on April 25, 2021, 5:23 p.m.