stereo.core.StPipeline.filter_by_hvgs#

StPipeline.filter_by_hvgs(hvg_res_key='highly_variable_genes', filter_raw=True, inplace=False)[source]#

Filter genes based on the result of highly_variable_genes function.

Parameters:
  • hvg_res_key (str) – the key of highly variable genes to get corresponding result.

  • filter_raw (bool) – whether to filter raw data meanwhile.

  • inplace (bool) – whether to inplace the previous data or return a new data.

Returns:

  • An object of StereoExpData.

  • Depending on inplace, if True, the data will be replaced by those filtered.