oxbow.read_bed

Contents

oxbow.read_bed#

oxbow.read_bed(src, bed_schema, region=None, index=None, fields=None, compressed=False)#

Return Arrow IPC format from a BED file.

Parameters:

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

  • bed_schema (str, list[tuple[str, str]], or dict[str, str]) – The BED schema.

  • region (str) – Genomic range string in the format “chr:start-end”, “chr:[start,end]” or “chr:[start,end)”.

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

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

Returns:

Arrow IPC

Return type:

bytes

Contents