dandelion.polars.io.read_10x_airr

dandelion.polars.io.read_10x_airr(file, prefix=None, suffix=None, sep='_', remove_trailing_hyphen_number=False, verbose=False)[source]

Read the airr_rearrangement.tsv produced from Cell Ranger directly and returns a DandelionPolars object.

This is not to be used for any airr rearrangement file, but specifically for the one produced by 10x Genomics. For standard airr rearrangement files e.g. all_contig_dandelion.tsv, use Dandelion/DandelionPolars or read_airr directly.

Parameters:

  • file (Path | str) – path to airr_rearrangement.tsv

  • prefix (str | None, optional) – Prefix to append to sequence_id and cell_id.

  • suffix (str | None, optional) – Suffix to append to sequence_id and cell_id.

  • sep (str, optional) – the separator to append suffix/prefix.

  • remove_trailing_hyphen_number (bool, optional) – whether or not to remove the trailing hyphen number e.g. ‘-1’ from the cell/contig barcodes.

  • verbose (bool, optional) – whether or not to print messages during creation of the DandelionPolars object.

Returns:

DandelionPolars object from 10x AIRR file.

Return type:

DandelionPolars