FACSPy.tl.harmony_integrate

FACSPy.tl.harmony_integrate#

FACSPy.tl.harmony_integrate(adata, gate, layer, key, basis='pca', adjusted_basis='pca_harmony', copy=False, **kwargs)#

Computes harmony integration.

Parameters:

  • adata (AnnData) – The anndata object of shape n_obs x n_vars where rows correspond to cells and columns to the channels

  • gate (str) – The gate to be analyzed, called by the population name. This parameter has a default stored in fp.settings, but can be superseded by the user.

  • layer (str) – The layer corresponding to the data matrix. Similar to the gate parameter, it has a default stored in fp.settings which can be overwritten by user input.

  • key (str) – Column in .obs that specifies the batch.

  • basis (str) – Entry in .obsm that specifies the embedding.

  • adjusted_basis (str) – Name of the integrated embedding.

  • copy (bool) – Return a copy of adata instead of modifying inplace.

  • **kwargs (dict, optional) – keyword arguments that are passed directly to the sklearn.PCA function. Please refer to its documentation.

Returns:

Returns adata if copy = True, otherwise adds fields to the anndata object:

.obsm[adjusted_basis]

integrated embedding of the data

Return type:

AnnData or None

Examples

>>> import FACSPy as fp
>>> dataset
AnnData object with n_obs × n_vars = 615936 × 22
obs: 'sample_ID', 'file_name', 'condition', 'sex', 'batch'
var: 'pns', 'png', 'pne', 'pnr', 'type', 'pnn', 'cofactors'
uns: 'metadata', 'panel', 'workspace', 'gating_cols', 'dataset_status_hash'
obsm: 'gating'
layers: 'compensated', 'transformed'
>>> fp.settings.default_gate = "T_cells"
>>> fp.settings.default_layer = "transformed"
>>> fp.tl.pca(dataset)
>>> fp.tl.harmony_integrate(
...     dataset,
...     basis = "X_pca_T_cells_transformed",
...     adjusted_basis = "X_pca_T_cells_transformed_harmony",
... )
Contents