sainsc.io.read_gem_file
=======================

.. py:function:: sainsc.io.read_gem_file(filepath, *, sep = '\t', n_threads = None, **kwargs)

   Read a GEM file into a DataFrame.

   GEM files are used by e.g. Stereo-Seq and Nova-ST.

   The name of the count column should be 'MIDCount', however,
   `MIDCounts` and `UMICount` are supported.

   :param filepath: Path to the GEM file.
   :type filepath: os.PathLike or str
   :param sep: Separator used in :py:func:`polars.read_csv`.
   :type sep: str, optional
   :param n_threads: Number of threads used for reading file and processing. If `None` or 0 this will
                     default to the number of available CPUs.
   :type n_threads: int, optional
   :param kwargs: Other keyword arguments will be passed to :py:func:`polars.read_csv`.

   :rtype: polars.DataFrame

   :raises ValueError: If count column has an unknown name.