dandelion.utilities.update_metadata

dandelion.utilities.update_metadata(self, retrieve=None, isotype_dict=None, split_heavy_light=True, collapse=False, clones_sep=None, clone_key=None)

A Dandelion function to update and populate the .metadata slot.

Parameters

• self (Dandelion) – Dandelion object

• retrieve (str) – column name in .data slot.

• split_heavy_light (bool) – Returns the retrieval splitted into two column for heavy and light. Default is True. False combines the retrieval into a single column.

• collapse (bool) – Whether or not to collapse unique elements if duplicated. For example, different contigs and same sample id would then benefit from this option being set to True.

• clones_sep (tuple[int, str]) – A tuple containing how the clone groups should be extracted. None defaults to (0, ‘_’).

Returns

Return type

Dandelion object with .metadata slot initialized.