ovrlpy.io.read_Xenium
=====================

.. py:function:: ovrlpy.io.read_Xenium(filepath, *, min_qv = None, remove_features = XENIUM_CTRLS, additional_columns = [], n_threads = None)

   Read a Xenium transcripts file.

   :param filepath: Path to the Xenium transcripts file. Both, .csv.gz and .parquet files, are supported.
   :type filepath: os.PathLike or str
   :param min_qv: Minimum Phred-scaled quality value (Q-Score) of a transcript to be included.
                  If `None` no filtering is performed.
   :type min_qv: float | None, optional
   :param remove_features: List of regex patterns to filter the 'feature_name' column,
                           :py:attr:`ovrlpy.io.XENIUM_CTRLS` by default.
   :type remove_features: collections.abc.Collection[str], optional
   :param additional_columns: Additional columns to load from the transcripts file.
   :type additional_columns: collections.abc.Collection[str], optional
   :param n_threads: Number of threads used for parsing the input file.
                     If None, will default to number of available CPUs.
   :type n_threads: int | None, optional

   :rtype: polars.DataFrame