bsxplorer.Genome.from_custom

classmethod Genome.from_custom(file: str | Path, chr_col: int = 0, start_col: int = 1, end_col: int = 2, id_col: int | None = None, strand_col: int | None = None, type_col: int | None = None, comment_char: str = '#', has_header: bool = False, read_filters: Expr | None = None) Genome[source]

Create Genome from custom tab separated file with genomic regions.

Warning

Index for columns starts from 0!

Parameters:
  • file – Path to file.

  • chr_col – Index of chromosome column.

  • start_col – Index of region start column.

  • end_col – Index of region end column.

  • id_col – Index of id column (if exists).

  • strand_col – Index of strand column.

  • type_col – Index of type column (if exists).

  • comment_char – Character for comments in file.

  • has_header – Does file have header.

  • read_filters – Filter annotation by polars.Expr

Return type:

Instance of Genome