builtInClusteringFunctions: Built in ClusterFunction options

Description Usage Arguments Details See Also Examples

Description

Documents the built-in clustering options that are available in the clusterExperiment package.

Usage

1
2
3
4
5
6
7
8
listBuiltInFunctions()

## S4 method for signature 'character'
getBuiltInFunction(object)

listBuiltInTypeK()

listBuiltInType01()

Arguments

object

name of built in function.

Details

listBuiltInFunctions will return the character names of the built-in clustering functions available.

listBuiltInTypeK returns the names of the built-in functions that have type 'K'

listBuiltInType01 returns the names of the built-in functions that have type '01'

getBuiltInFunction will return the ClusterFunction object of a character value that corresponds to a built-in function.

algorithmType and inputType will return the algorithmType and inputType of the built-in clusterFunction corresponding to the character value.

Built-in clustering methods: The built-in clustering methods, the names of which can be accessed by listBuiltInFunctions() are the following:

See Also

ClusterFunction, algorithmType, inputType

Examples

1
2
3
4
5
listBuiltInFunctions()
algorithmType(c("kmeans","pam","hierarchical01"))
inputType(c("kmeans","pam","hierarchical01"))
listBuiltInTypeK()
listBuiltInType01()

Bioconductor-mirror/clusterExperiment documentation built on Aug. 2, 2017, 4:28 p.m.