scglue.data.aggregate_obs
- scglue.data.aggregate_obs(adata, by, X_agg='sum', obs_agg=None, obsm_agg=None, layers_agg=None)[source]
Aggregate obs in a given dataset by certain categories
- Parameters
adata (
AnnData
) – Dataset to be aggregatedby (
str
) – Specify a column inadata.obs
used for aggregation, must be discrete.X_agg (
typing.Optional
[str
]) – Aggregation function foradata.X
, must be one of{"sum", "mean", ``None
}``. Setting toNone
discards theadata.X
matrix.obs_agg (
typing.Optional
[typing.Mapping
[str
,str
]]) – Aggregation methods foradata.obs
, indexed by obs columns, must be one of{"sum", "mean", "majority"}
, where"sum"
and"mean"
are for continuous data, and"majority"
is for discrete data. Fields not specified will be discarded.obsm_agg (
typing.Optional
[typing.Mapping
[str
,str
]]) – Aggregation methods foradata.obsm
, indexed by obsm keys, must be one of{"sum", "mean"}
. Fields not specified will be discarded.layers_agg (
typing.Optional
[typing.Mapping
[str
,str
]]) – Aggregation methods foradata.layers
, indexed by layer keys, must be one of{"sum", "mean"}
. Fields not specified will be discarded.
- Return type
- Returns
aggregated – Aggregated dataset