Skip to contents

Reads the transcript localization and metadata table. This table will be used by subsequent function in this package.

Usage

readTxMeta(path, platform)

Arguments

path

The file path from which to read the transcriptome metadata.

platform

The platform for which the transcriptome metadata is being read. Valid options are 'Xenium', 'CosMx', and 'Merscope'.

Value

Returns a data table with the transcriptome metadata. For 'Xenium', the 'feature_name' column is renamed to 'target'. For 'CosMx', the transcriptome file matching '*tx_file.csv.gz' is read.

Details

#' This function reads transcriptome metadata from a specified path, depending on the platform specified. Currently supports 'Xenium' and 'CosMx' platforms. For 'Xenium', it reads 'transcripts.csv.gz' and renames the 'feature_name' column to 'target' for consistency. For 'CosMx', it reads the appropriate transcriptome file matched by '*tx_file.csv.gz'.