iggytop.adapters.neotcr_adapter.NEOTCRAdapter

class iggytop.adapters.neotcr_adapter.NEOTCRAdapter(bc, cache_dir=None, receptors_to_include=('TCR', 'BCR'), test=False, filter_10x=False)

BioCypher adapter for the NeoTCR dataset.

__init__(bc, cache_dir=None, receptors_to_include=('TCR', 'BCR'), test=False, filter_10x=False)

Initializes the BaseAdapter instance.

Parameters:

• bc (BioCypher) – An instance of the BioCypher class.

• cache_dir (str | None) – Directory to cache data. Defaults to None.

• receptors_to_include (Optional[Sequence[Literal['TCR', 'BCR']]]) – Receptors to include. Defaults to (“TCR”, “BCR”).

• test (bool) – Whether to run in test mode. Defaults to False.

• filter_10x (bool) – Whether to filter out 10X Genomics datasets. Defaults to False.

Methods

__init__(bc[, cache_dir, ...])	Initializes the BaseAdapter instance.
create_anndata()	Creates an Anndata object from the AIRR cell data and saves it to a file in the cache directory.
get_edges()	Abstract method to generate BioCypher edges from the data.
get_latest_release(bc)	Retrieves the latest release of the NeoTCR database.
get_nodes()	Abstract method to generate BioCypher nodes from the data.
read_table(bc, table_path, receptors[, test])	Reads and processes the NeoTCR table from the downloaded database file.
set_metadata([version, source_url, ...])	Sets the metadata for the adapter.

Attributes

DB_DIR	Directory name for the downloaded database.
DB_NAME	Name of the database.
FILE_NAME	File name of the NeoTCR database.
RAW_URL	URL to download the NeoTCR database.
airr_cells	Property to get the list of AIRR cells.
available_receptors	Receptor types available in NeoTCR.
cache_dir	Property to get the cache directory.
db_name	Property to get the database name.
metadata	Property to get the adapter metadata.
receptors	Property to get the available receptor types.
table	Property to get the data table.

get_edges()

Abstract method to generate BioCypher edges from the data.

This method is intended to call _generate_edges_from_table with the right parameters for each edge type. This requires parameters depending on the adapter used.

Yields:

tuple – A BioCypher edge (id, source, target, type, properties).

get_latest_release(bc)

Retrieves the latest release of the NeoTCR database.

Parameters:

bc (BioCypher) – An instance of the BioCypher class.

Return type:

str

Returns:

Path to the latest release file.

get_nodes()

Abstract method to generate BioCypher nodes from the data.

This method is intended to use _generate_nodes_from_table with the right parameters for each edge type. This requires parameters depending on the adapter used.

Yields:

tuple – A BioCypher node (id, type, properties).

read_table(bc, table_path, receptors, test=False)

Reads and processes the NeoTCR table from the downloaded database file.

Parameters:

• bc (BioCypher) – An instance of the BioCypher class.

• table_path (str) – Path to the table file.

• receptors (list[str]) – List of receptor types to include in the table (Ignored as only TCR is available).

• test (bool) – If True, loads only a subset of the data for testing (default is False).

Return type:

DataFrame

Returns:

A DataFrame containing the processed table data.

Raises:

FileNotFoundError – If the table file cannot be found.

DB_DIR = 'neotcr_latest'

Directory name for the downloaded database.

DB_NAME: str = 'NEOTCR'

Name of the database.

FILE_NAME = 'NeoTCR_data-20221220.xlsx'

File name of the NeoTCR database.

RAW_URL = 'https://github.com/lyotvincent/NeoTCR/raw/main/data/NeoTCR%20data-20221220.xlsx'

URL to download the NeoTCR database.

_abc_impl = <_abc._abc_data object>

available_receptors: list[str] = ['TCR']

Receptor types available in NeoTCR.