gmmd.classifier.obtain_SSD_list

gmmd.classifier.obtain_SSD_list(data, sample_num, class_id_ary=None)

Return GEM barcodes that are SSDs.

Parameters

• data (pandas.DataFrame) – Purified classification result, generated by gmmd.classifier.purify_droplets().

• sample_num (int) – Number of HTO samples.

• class_id_ary (list, Default = None) – To extract specific class, provide an id array.

Return type

list

Example

>>> obtain_SSD_list(data, 4, [5, 11])

Returns SSDs that contain cluster id 5 or 11.

e.g. HTO samples are HTO_1, HTO_2, HTO_3, HTO_4, then cluster id 5 will be HTO_1+HTO_2, and 11 will be HTO_1+HTO_2+HTO_3.