ChooseClusteringState

ChooseClusteringState

This step chooses between the k-means and SNN graph clusterings from KmeansClusterState and SnnGraphClusterState, respectively. We added this step to preserve the cache for each clustering step - specifically, each clustering does not need to be recomputed when a user changes their choice.

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

Classes

ChooseClusteringState

Methods

compute(parameters)

Description:

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

Source:
Parameters:
Name Type Description
parameters object

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

Properties
Name Type Description
method string

Clustering method to use, either "kmeans" or "snn_graph".
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