KmeansClusterState

KmeansClusterState

This step performs k-means clustering on the PCs, wrapping the clusterKmeans function from scran.js.

Methods not documented here are not part of the stable API and should not be used by applications.

Classes

KmeansClusterState

Methods

compute(run_me, parameters)

Description:

  • This method should not be called directly by users, but is instead invoked by runAnalysis.

Source:
Parameters:
Name Type Description
run_me boolean

Whether or not to run this step, depending on the clustering method chosen by the user (see ChooseClusteringState).
parameters object

Parameter object, equivalent to the choose_clustering property of the parameters of runAnalysis.

Properties
Name Type Description
k number

Number of clusters to create.
Returns:

The object is updated with the new results.

fetchClusters() → {Int32WasmArray}

Source:
Returns:

Array of cluster assignments for each cell in the (filtered) dataset, available after running compute.

Type
Int32WasmArray

fetchParameters() → {object}

Source:
Returns:

Object containing the parameters.

Type
object