_Assay.hierarchical_cluster

_Assay.hierarchical_cluster#

missionbio.mosaic.assay._Assay.hierarchical_cluster

classmethod _Assay.hierarchical_cluster(dat: DataFrame, index: bool = False, **kwargs: Any) → ndarray#

Get the hierarchical clustering order of the index of the dataframe.

Parameters:
datUnion[pd.DataFrame, np.ndarray]

The dataframe to be clustered.

indexbool

The names of the indices are returned if index is False and the list of the ordered indices is returned if index is True. For an np.ndarray this parameter does not have any effect.

kwargsAny

Additional keyword arguments to be passed to scipy.cluster.hierarchy.linkage(). The default is:

  • metric=”cityblock”

  • method=”average”

  • optimal_ordering=False

Returns:
np.ndarray

The hierarchical clustering order of the columns.

< Class _Assay

Contents