stereo.core.StPipeline.annotation#

StPipeline.annotation(annotation_information, cluster_res_key='cluster', default=None, res_key='annotation')[source]#

Set annotation to clusters.

Parameters:

  • annotation_information (Union[list, dict]) – describe the annotation information to the clusters in a list or dictionary format. # noqa

  • cluster_res_key (str) – get the targeted cluster result to add annotation.

  • default (Optional[str]) – the default value for the groups without being annotated, if None, remain the original value.

  • res_key (str) – the key for storing annotation result in self.result.