oxbow.read_bam

Contents

oxbow.read_bam#

oxbow.read_bam(src, region=None, index=None, fields=None, tag_defs=None, compressed=True)#

Return Arrow IPC format from a BAM file.

Parameters:

  • src (str or file-like) – The path to the source file or a file-like object.

  • fields (list[str], optional) – Names of the fixed fields to project.

  • tag_defs (list[tuple[str, str]], optional) – Definitions of tag fields to project.

  • compressed (bool, optional [default: True]) – Whether the source is BGZF-compressed.

Returns:

Arrow IPC

Return type:

bytes

Contents