cellrank.tl.lineage_drivers¶

cellrank.tl.
lineage_drivers
(adata, backward=False, lineages=None, method='fischer', cluster_key=None, clusters=None, layer='X', use_raw=False, confidence_level=0.95, n_perms=1000, seed=None, return_drivers=True, **kwargs)[source]¶ Compute driver genes per lineage.
Correlates gene expression with lineage probabilities, for a given lineage and set of clusters. Often, it makes sense to restrict this to a set of clusters which are relevant for the specified lineages.
 Parameters
adata¶ (
anndata.AnnData
) – Annotated data object.lineages¶ (
Union
[str
,Sequence
,None
]) – Either a set of lineage names fromabsorption_probabilities
.names or None, in which case all lineages are considered.Mode to use when calculating pvalues and confidence intervals. Can be one of:
’fischer’  use Fischer transformation [Fischer21].
’perm_test’  use permutation test.
cluster_key¶ (
Optional
[str
]) – Key fromadata
.obs
to obtain cluster annotations. These are considered forclusters
.clusters¶ (
Union
[str
,Sequence
,None
]) – Restrict the correlations to these clusters.use_raw¶ (
bool
) – Whether or not to useadata
.raw
to correlate gene expression. If using a layer other than.X
, this must be set to False.confidence_level¶ (
float
) – Confidence level for the confidence interval calculation. Must be in [0, 1].n_perms¶ (
int
) – Number of permutations to use whenmethod='perm_test'
.seed¶ (
Optional
[int
]) – Random seed whenmethod='perm_test'
.return_drivers¶ (
bool
) – Whether to return the drivers. This also contains the lower and upperconfidence_level
confidence interval bounds.show_progress_bar¶ – Whether to show a progress bar. Disabling it may slightly improve performance.
n_jobs¶ – Number of parallel jobs. If 1, use all available cores. If None or 1, the execution is sequential.
 Returns
Dataframe of shape
(n_genes, n_lineages * 5)
containing the following columns, 1 for each lineage:{lineage} corr
 correlation between the gene expression and absorption probabilities.{lineage} pval
 calulated pvalues for doublesided test.{lineage} qval
 corrected pvalues using BenjaminiHochberg method at level 0.05.{lineage} ci low
 lower bound of theconfidence_level
correlation confidence interval.{lineage} ci high
 upper bound of theconfidence_level
correlation confidence interval.
Only if
return_drivers=True
. Return type
References
 Fischer21
Fisher, R. A. (1921), On the “probable error” of a coefficient of correlation deduced from a small sample., Metron 1 3–32.