scgenome.tl.aggregate_clusters

scgenome.tl.aggregate_clusters#

scgenome.tl.aggregate_clusters(adata, agg_X=None, agg_layers=None, agg_obs=None, cluster_col='cluster_id', cluster_size_col='cluster_size')#

Aggregate copy number by cluster to create cluster CN matrix

Parameters:
  • adata (AnnData) – copy number data

  • agg_X (Any) – function to aggregate X, by default None

  • agg_layers (Dict, optional) – functions to aggregate layers keyed by layer names, by default None

  • agg_obs (Dict, optional) – functions to aggregate obs data keyed by obs columns, by default None

  • cluster_col (str, optional) – column with cluster ids, by default ‘cluster_id’

  • cluster_size_col (str, optional) – column that will be set to the size of each cluster, by default ‘cluster_size’

Returns:

aggregated cluster copy number

Return type:

AnnData