hest.readers.STReader

class hest.readers.STReader

Legacy Spatial Transcriptomics reader

Methods table

auto_read(path, **read_kwargs)	Automatically detect the file names and determine a reading strategy based on the detected files.
read([meta_table_path, raw_counts_path, ...])

Methods

STReader.auto_read(path: str, **read_kwargs) → HESTData

Automatically detect the file names and determine a reading strategy based on the detected files. For more control on the reading process, consider using read() instead

Parameters:

path (st) – path to the directory containing all the necessary files

Returns:

STObject that was read

Return type:

HESTData

STReader.read(meta_table_path=None, raw_counts_path=None, img_path=None, spot_coord_path=None, transform_path=None, packing: SpotPacking = SpotPacking.GRID_PACKING, spot_diameter=100.0, inter_spot_dist=200.0, custom_adata=None) → STHESTData