liana.ds.sample_lrs

liana.ds.sample_lrs(by_sample=False)

Build a toy ligand-receptor result frame, shaped like a method’s output.

Parameters:

by_sample bool (default: False)

Whether to add a categorical sample column of four samples, as the multi-sample functions expect.

Return type:

DataFrame

Returns:

A DataFrame of source/target cell types, ligand_complex/ receptor_complex pairs, and random magnitude and specificity_rank scores.