annsel.AnnselAccessor.select

annsel.AnnselAccessor.select#

AnnselAccessor.select(self, obs=None, var=None, x=None, copy=False)[source]#

Select the AnnData object by the given predicates.

Parameters:
obs Expr | str | Series | Iterable[Expr | str | Series] | None (default: None)

Predicates to filter the observations by.

var Expr | str | Series | Iterable[Expr | str | Series] | None (default: None)

Predicates to filter the variables by.

x Expr | str | Series | Iterable[Expr | str | Series] | None (default: None)

Predicates to filter the data by.

layer

The layer to filter.

copy bool (default: False)

Whether to return a copy of the AnnData object.

Return type:

AnnData

Returns:

The selected AnnData object.

Examples

>>> import annsel as an
>>> adata = an.datasets.leukemic_bone_marrow_dataset()
>>> adata.an.select(
...     obs=an.col(["Cell_label", "sex"]),
...     var=an.col(["feature_name"]),
...     x=an.col(["ENSG00000205336"]),
... )
AnnData object with n_obs × n_vars = 31586 × 1
    obs: 'Cell_label', 'sex'
    var: 'feature_name'
    uns: 'cell_type_ontology_term_id_colors', 'citation', 'default_embedding', 'schema_reference', 'schema_version', 'title'
    obsm: 'X_bothumap', 'X_pca', 'X_projected', 'X_projectedmean', 'X_tsneni', 'X_umapni'
Contents